Required scopes: campaigns_read
Arguments
The discount code’s id, or its legacyId from an earlier version of the Redo API.
Returns
A discount configuration hosted on Shopify or BigCommerce.
The code customers enter at checkout.
When the discount was created.
A short human-readable summary of what the code does.
When this code stops working.
The expiry instant when type is ON_DATE.
Days after creation when type is AFTER_DAYS.
Whether the code never expires, expires on a date, after a number of days, or on delivery.
The platform’s id for this discount (a Shopify GID or a BigCommerce promotion id).
Whether this is one fixed code or a unique code per customer.
The id of this discount code.
How the discount reduces the order. Null when the config has no settings type.
The discount’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The commerce platform that hosts this code.
How the discount reduces the order.
The merchant-facing name of the discount.
When the discount was last edited.
Example