String
The code customers enter at checkout.
When the code stops working.
Show fields
Show fields
Int
Required when
type is AFTER_DAYS.Whether the code never expires, expires on a date, or after a number of days.
Must be STATIC. DYNAMIC is not supported.
Replace how the discount reduces the order. Pass exactly one of amountOff, freeShipping, or buyXGetY.
Show fields
Show fields
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 other discounts this code may stack with.
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.
[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.
Which other discounts this code may stack with.
required
What the customer must buy to unlock the Y items.
Which customers may use the code.
required
What the customer gets, and at what discount.
[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.
Which other discounts this code may stack with.
[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.
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.
String
The merchant-facing name of the discount.