Backend API
Fields
Unique identifier for the promotion.
A short descriptive name of the promo.
Indicates the promo is currently active. Note: this is not affected by date_start and date_end.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date and time the promotion was created.
Date the promo ends and is no longer available. When defined, the promo will not be applied after this date.
Date the promo is first available. When defined, the promo will not be valid until after this date and before date_end.
Date and time the promotion was last updated.
A brief description of the promo, as it may be displayed to customers.
ID of the discount group the promo belongs to, if applicable, as defined in discount settings. Used to ensure only one set of discount rules can apply across a number of coupons and promotions.
List of discount rules to apply.
Items required to be purchased in order to receive the promotion.
Unique identifier for the category.
Expandable link to the category.
Unique identifier for the product.
Expandable link to the product.
Expandable link to the discounted category, if applicable.
ID of the category to discount, if applicable.
Maximum redeemable discount amount for the coupon.
Expandable list of excluded categories, if applicable.
List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.
Eligible discounted items available once promotion's buy_items requirements are met.
Unique identifier for the category.
Expandable link to the category.
Unique identifier for the product.
Expandable link to the product.
Indicates whether the get_items promotion requirements have been met.
Minimum product price required for the rule to apply, applicable for category and product discounts.
Expandable link to the discounted product, if applicable.
ID of the product to discount, if applicable.
Maximum product quantity for which the rule will apply, applicable for category and product discounts.
Minimum product quantity required for the rule to apply, applicable for category and product discounts.
ID of the shipping service to discount, if applicable.
Minimum order total required for the rule to apply.
Type of discount to apply. Can be total, product, category or shipment.
Possible enum values:
Fixed discount applied when value_type=fixed.
Percentage discount applied when value_type=percent.
ID of the variant to discount, if applicable.
Type of discount amount to calculate. Can be fixed or percent.
Possible enum values:
Purchase option the discount applies to.
Possible enum values:
ID of the subscription plan the discount applies to, when purchase_option is subscription_plan.
Expandable link to the discounted variant, if applicable.
List of exclusions considered when the promo is applied.
ID of the category to exclude from the promo.
Expandable link to the category excluded from the promo.
ID of the product to exclude from the promo.
Expandable link to the product excluded from the promo.
Type of exclusion. Can be product or category.
Possible enum values:
List of customer account for which the promo will apply.
Maximum number of times the promo will be applied by each customer account.
Maximum number of times the promo will be applied across all customers.
Expandable list of orders that have applied the promo.
Expandable list of subscriptions that have applied the promo.
Number of times the promo has been applied.
Expandable list of promotion use records.
The promotion model
{
"id": "60f199509111e7000000006b",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}