Discount Properties

Discount Code Properties

NameTypeDescription
codestringCoupon Code
customer_selectionstringRange of customer
discount_typestringOffer type: fixed_amount discount, percentage discount
ends_atstringActivity end time - Time Stamp
entitled_collection_idsarrayBuy collection ids
entitled_extra_listarrayExcluded entities
entitled_product_idsarrayBuy product ids
once_per_customerstringNumber of personal use limit
prerequisitestringWith or without precondition :1 yes, 0 no
prerequisite_customer_idsarrayPrerequisite customer ids
prerequisite_threshold_quantity_rangeobjectQuantity threshold
prerequisite_threshold_subtotal_rangeobjectAmount threshold
prerequisite_subtotal_rangeobjectFull discount offer amount rule
product_numintegerNumber of products
progressstringActivity status: ongoing in progress, not_started not started, finished ended, usable available
starts_atstringActivity start Time - Time Stamp
statusstringActivity status ( 0 Invalid; 1 Valid )
target_selectionstringTarget selection can only be all
target_typestringTarget type: line_item shipping_line
times_usedstringNumber of times the rule is enabled (consumed)
titlestringActivity name
usage_limitstringTotal number of offers for the campaign
use_with_otherstringWhether to use with other activities at the same time (1:yes,0:no)
using_statestringThe usage status of the offer, default normal: normal use, reopen re-enable
value_typestringRule preference value type:
percentage fixed_amount buy_x_get_y fixed_price
detail_urlstringLanding page link
valuestringRule offer Value
prerequisite_quantity_rangeobjectFull discount offer tier information

Discount Rebate Data Properties

NameTypeDescription
titlestringActivity name
discount_typestringOffer type: fixed_amount percentage
once_per_customerstringNumber of personal use limit
statusstringActivity Status :0 Invalid,1 Valid
starts_atstringActivity start Time - Time Stamp
ends_atstringActivity end time - Time Stamp
allocation_methodstringPrice preference allocation method
progressstringActivity status: ongoing in progress, not_started not started, finished ended, usable available
product_numintegerNumber of products
detail_urlstringLanding page link

Discount Flashsal Data Properties

NameTypeDescription
customer_selectionstringRange of customer
discount_typestringOffer type: fixed_amount , percentage
ends_atstringActivity end time - Time Stamp
entitled_filter_idsarrayFilter ids
entitled_filter_listarrayFilter list
entitled_product_idsarrayBuy product ids
global_show_textstringGlobal text display: openshow, close don't show
once_per_customerstringNumber of personal use limit
prerequisitestringWith or without precondition :1 yes, 0 no
prerequisite_customer_idsarrayPrerequisite customer ids
prerequisite_threshold_quantity_rangearrayQuantity threshold
prerequisite_threshold_subtotal_rangearrayAmount threshold
prerequisite_subtotal_rangearrayFull discount offer amount rule
product_numintegerNumber of products
progressstringActivity status: ongoing in progress, not_started not started, finished ended, usable available
starts_atstringActivity tart Time - Time Stamp
statusstringActivity status :0 Invalid,1 Valid
times_usedstringNumber of times the rule is enabled (consumed)
titlestringActivity name
value_typestringRule preference value type:
percentage fixed_amount buy_x_get_y fixed_price
detail_urlstringLanding page link
valuestringRule Offer Value

Popup Data Properties

NameTypeDescription
subscribestringNumber of successful participation
conversion_ratestringConversion rate
exposurestringNumber of exposures
activity_detailobjectActivity detail

Popup activity_detail Properties

NameTypeDescription
titlestringActivity name
starts_atstringActivity start Time - Time Stamp
ends_atstringActivity end time - Time Stamp
statusstringActivity status: 1 Normal, 2 Suspended, 0 Deleted

Salespop Config Properties

NameTypeDescription
order_statusstringOrder range: all paid
timestringProduct Range, Recommended orders were generated in the last {time}
time_unitstringProduct Range, Recommended orders generated from the nearest unit
statusstringConfig status: open
template_configobjectConfig template

Salespop Config template_config Properties

NameTypeDescription
templatestringFloat notification template: 1 2 3
replace_switchbooleanReplace switch
default_timestringDefault time. example: '24'
anonymity_switchbooleanAnonymity switch

Salespop Datagraph Properties

NameTypeDescription
clickintegerNumber of clicks
exposureintegerNumber of exposures
purchaseintegerNumber of paid orders
salesintegerTransaction amount