A percent-off or amount-off discount.
Show fields
Show fields
Float!
required
Percent off (0–100) when
valueType is PERCENTAGE; otherwise a currency amount.Boolean
Whether each customer may use the code only once.
[String!]
Platform collection ids this code applies to.
Which customers may use the code.
[String!]
Platform customer ids when eligibility is SPECIFIC.
Boolean
Whether items already on sale are excluded.
A minimum purchase required to use the code.
Show fields
Show fields
Float!
required
The required quantity or subtotal.
required
Whether
minimum is a quantity or a subtotal.[String!]
Platform product ids this code applies to.
Whether the code applies to one-time, subscription, or both.
Float
How many subscription cycles the code applies to.
[String!]
Platform segment ids when eligibility is SEGMENTS.
Float
Maximum times this code may be used in total.
required
Whether
amount is a percent or a currency amount.A buy-X-get-Y discount.
Show fields
Show fields
Boolean
Whether each customer may use the code only once.
required
What the customer must buy to unlock the Y items.
Show fields
Show fields
Float
Required spend when
triggerType is MINIMUM_AMOUNT.Collections that count toward X.
Products that count toward X.
Float
Required quantity when
triggerType is MINIMUM_QUANTITY.required
Whether the customer must buy a quantity or spend an amount.
Which customers may use the code.
required
What the customer gets, and at what discount.
Show fields
Show fields
Float!
required
Percent off (0–100) when
valueType is PERCENTAGE; otherwise a currency amount.Collections the customer gets.
Products the customer gets.
Float!
required
How many Y items the customer gets.
required
Whether
amount is a percent or a currency amount off Y.[String!]
Platform customer ids when eligibility is SPECIFIC.
[String!]
Platform segment ids when eligibility is SEGMENTS.
Float
Maximum times this code may be used in total.
Float
How many times the Y items may be claimed on one order.
A free-shipping discount.
Show fields
Show fields
Boolean
Whether each customer may use the code only once.
[String!]
ISO country codes this free shipping applies to.
Which customers may use the code.
[String!]
Platform customer ids when eligibility is SPECIFIC.
Float
Shipping priced above this amount is not made free.
A minimum purchase required to use the code.
Show fields
Show fields
Float!
required
The required quantity or subtotal.
required
Whether
minimum is a quantity or a subtotal.Whether the code applies to one-time, subscription, or both.
Float
How many subscription cycles the code applies to.
[String!]
Platform segment ids when eligibility is SEGMENTS.
Float
Maximum times this code may be used in total.