discount_percentinteger nullable
bonus_percentinteger nullable
bonus_fixedinteger nullable
The user will receive a fixed quantity of the item.
descriptionstring nullable
image_urlstring uri nullable
max_purchasesinteger nullable
The maximum number of purchases allowed for the item per user.
global_max_purchasesinteger nullable
The maximum number of purchases allowed for the item across all users.
custom_badgestring nullable
The custom badge of the item
campaign_idstring nullable
user_campaign_idstring nullable
bond_user_idstring nullable
min_amountinteger nullable
max_reward_points_percentinteger nullable
reward_points_percentnumber nullable
Percentage of reward points for the item.
reward_points_fixedinteger nullable
Fixed reward points for the item.
loyalty_points_percentinteger nullable
Percentage of loyalty points for the item.
loyalty_points_fixedinteger nullable
Fixed loyalty points for the item.
rotation_weightinteger nullable
max_purchases_period_type'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second'
max_purchases_period_valueinteger nullable
max_purchases_limit_type'global' | 'personal'
show_disabled_by_max_purchasesboolean nullable
Whether to show the item as disabled when max purchases limit is reached.
requirements_mismatch_behavior'hide_from_store' | 'disable' | 'disable_and_show_description'
card_type'default' | 'featured'
show_first_on_category_listboolean nullable
Whether to show the item first on the category list
bonus_item_idstring nullable
The ID of the bonus item that will be given to the user when they purchase this item.
bonus_item_quantityinteger nullable
The fixed quantity of the bonus item
bonus_item_percentinteger nullable
The user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.
bonus_badgestring nullable
Custom text for bonus badge
priceinteger nullable
The price of the item in minor currency units. The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use price_template_id instead.
price_pointinteger nullable
price_template_idstring nullable
The ID of the price template
created_atnumber required
created_from_campaign_node_idstring nullable
created_from_campaign_versionstring nullable
current_purchase_countinteger
background_image_urlstring uri
applied_store_promotion_idstring
applied_store_promotion_idsstring[]