Discount Properties

Discount Code Properties

Name

Type

Description

code

string

Coupon Code

customer_selection

string

Range of customer

discount_type

string

Offer type: fixed_amount discount, percentage discount

ends_at

string

Activity end time - Time Stamp

entitled_collection_ids

array

Buy collection ids

entitled_extra_list

array

Excluded entities

entitled_product_ids

array

Buy product ids

once_per_customer

string

Number of personal use limit

prerequisite

string

With or without precondition :1 yes, 0 no

prerequisite_customer_ids

array

Prerequisite customer ids

prerequisite_threshold_quantity_range

object

Quantity threshold

prerequisite_threshold_subtotal_range

object

Amount threshold

prerequisite_subtotal_range

object

Full discount offer amount rule

product_num

integer

Number of products

progress

string

Activity status: ongoing in progress, not_started not started, finished ended, usable available

starts_at

string

Activity start Time - Time Stamp

status

string

Activity status ( 0 Invalid; 1 Valid )

target_selection

string

Target selection can only be all

target_type

string

Target type: line_item shipping_line

times_used

string

Number of times the rule is enabled (consumed)

title

string

Activity name

usage_limit

string

Total number of offers for the campaign

use_with_other

string

Whether to use with other activities at the same time (1:yes,0:no)

using_state

string

The usage status of the offer, default normal: normal use, reopen re-enable

value_type

string

Rule preference value type:
percentage fixed_amount buy_x_get_y fixed_price

detail_url

string

Landing page link

value

string

Rule offer Value

prerequisite_quantity_range

object

Full 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

Name

Type

Description

customer_selection

string

Range of customer

discount_type

string

Offer type: fixed_amount , percentage

ends_at

string

Activity end time - Time Stamp

entitled_filter_ids

array

Filter ids

entitled_filter_list

array

Filter list

entitled_product_ids

array

Buy product ids

global_show_text

string

Global text display: openshow, close don't show

once_per_customer

string

Number of personal use limit

prerequisite

string

With or without precondition :1 yes, 0 no

prerequisite_customer_ids

array

Prerequisite customer ids

prerequisite_threshold_quantity_range

array

Quantity threshold

prerequisite_threshold_subtotal_range

array

Amount threshold

prerequisite_subtotal_range

array

Full discount offer amount rule

product_num

integer

Number of products

progress

string

Activity status: ongoing in progress, not_started not started, finished ended, usable available

starts_at

string

Activity tart Time - Time Stamp

status

string

Activity status :0 Invalid,1 Valid

times_used

string

Number of times the rule is enabled (consumed)

title

string

Activity name

value_type

string

Rule preference value type:
percentage fixed_amount buy_x_get_y fixed_price

detail_url

string

Landing page link

value

string

Rule 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

TypeTypeDescription
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