Skip to content

Latest commit

 

History

History
132 lines (116 loc) · 5.14 KB

ExportParameters.md

File metadata and controls

132 lines (116 loc) · 5.14 KB

ExportParameters

Properties

Name Type Description
order OrderEnum
fields List<FieldsEnum> Array of strings containing the data in the export. These fields define the headers in the CSV file.
filters ExportParametersFilters

Enum: OrderEnum

Name Value
_CREATED_AT "-created_at"
CREATED_AT "created_at"
_UPDATED_AT "-updated_at"
UPDATED_AT "updated_at"
_CODE "-code"
CODE "code"
_ID "-id"
ID "id"
_VOUCHER_CODE "-voucher_code"
VOUCHER_CODE "voucher_code"
_TRACKING_ID "-tracking_id"
TRACKING_ID "tracking_id"
_CUSTOMER_ID "-customer_id"
CUSTOMER_ID "customer_id"

Enum: List<FieldsEnum>

Name Value
CODE "code"
VOUCHER_TYPE "voucher_type"
VALUE "value"
FORMULA "formula"
DISCOUNT_TYPE "discount_type"
CAMPAIGN "campaign"
CATEGORY "category"
START_DATE "start_date"
EXPIRATION_DATE "expiration_date"
GIFT_BALANCE "gift_balance"
LOYALTY_BALANCE "loyalty_balance"
REDEMPTION_QUANTITY "redemption_quantity"
REDEMPTION_COUNT "redemption_count"
ACTIVE "active"
QR_CODE "qr_code"
BAR_CODE "bar_code"
METADATA "metadata"
ID "id"
IS_REFERRAL_CODE "is_referral_code"
CREATED_AT "created_at"
UPDATED_AT "updated_at"
VALIDITY_TIMEFRAME_INTERVAL "validity_timeframe_interval"
VALIDITY_TIMEFRAME_DURATION "validity_timeframe_duration"
VALIDITY_DAY_OF_WEEK "validity_day_of_week"
DISCOUNT_AMOUNT_LIMIT "discount_amount_limit"
CAMPAIGN_ID "campaign_id"
ADDITIONAL_INFO "additional_info"
CUSTOMER_ID "customer_id"
DISCOUNT_EFFECT "discount_effect"
DISCOUNT_UNIT_TYPE "discount_unit_type"
DISCOUNT_UNIT_EFFECT "discount_unit_effect"
VALIDATION_RULES_ID "validation_rules_id"
CUSTOMER_SOURCE_ID "customer_source_id"
OBJECT "object"
DATE "date"
VOUCHER_CODE "voucher_code"
PROMOTION_TIER_ID "promotion_tier_id"
CUSTOMER_NAME "customer_name"
TRACKING_ID "tracking_id"
ORDER_ID "order_id"
ORDER_AMOUNT "order_amount"
GIFT_AMOUNT "gift_amount"
LOYALTY_POINTS "loyalty_points"
RESULT "result"
FAILURE_CODE "failure_code"
FAILURE_MESSAGE "failure_message"
NAME "name"
DESCRIPTION "description"
EMAIL "email"
SOURCE_ID "source_id"
ADDRESS_CITY "address_city"
ADDRESS_STATE "address_state"
ADDRESS_LINE_1 "address_line_1"
ADDRESS_LINE_2 "address_line_2"
ADDRESS_COUNTRY "address_country"
ADDRESS_POSTAL_CODE "address_postal_code"
REDEMPTIONS_TOTAL_REDEEMED "redemptions_total_redeemed"
REDEMPTIONS_TOTAL_FAILED "redemptions_total_failed"
REDEMPTIONS_TOTAL_SUCCEEDED "redemptions_total_succeeded"
REDEMPTIONS_TOTAL_ROLLED_BACK "redemptions_total_rolled_back"
REDEMPTIONS_TOTAL_ROLLBACK_FAILED "redemptions_total_rollback_failed"
REDEMPTIONS_TOTAL_ROLLBACK_SUCCEEDED "redemptions_total_rollback_succeeded"
ORDERS_TOTAL_AMOUNT "orders_total_amount"
ORDERS_TOTAL_COUNT "orders_total_count"
ORDERS_AVERAGE_AMOUNT "orders_average_amount"
ORDERS_LAST_ORDER_AMOUNT "orders_last_order_amount"
ORDERS_LAST_ORDER_DATE "orders_last_order_date"
LOYALTY_REFERRED_CUSTOMERS "loyalty_referred_customers"
PHONE "phone"
BIRTHDAY "birthday"
BIRTHDATE "birthdate"
CHANNEL "channel"
IS_WINNER "is_winner"
STATUS "status"
AMOUNT "amount"
DISCOUNT_AMOUNT "discount_amount"
ITEMS_DISCOUNT_AMOUNT "items_discount_amount"
TOTAL_DISCOUNT_AMOUNT "total_discount_amount"
TOTAL_AMOUNT "total_amount"
REFERRER_ID "referrer_id"
VOUCHER_ID "voucher_id"
POINTS "points"
EXPIRES_AT "expires_at"
TYPE "type"
REASON "reason"
SOURCE "source"
BALANCE "balance"
RELATED_TRANSACTION_ID "related_transaction_id"
DETAILS "details"