Get Order Level Discounts

Retrieves a list of order level discounts that appear on the storefront according to specified filter criteria.

Query Params
string

limits which fields are returned in the response body

Body Params
array of strings | null

List of product codes to query for discounts
Limit: 20 product codes

productCodes
boolean

Set false to exclude discounts that require one of the specified products to be purchased
default is true

boolean

When true, include discounts that are applied when there is no condition on the discount.
By default, these are not included.

array of int32s | null

List of customer segments that the discounts are applicable to.
If not specified, only discounts that are not restricted to any customer segment are returned.
When specified, only discounts that are applicable to one of the specified customer segments are returned.

customerSegmentIds
array of strings | null

List of discount labels to filter discounts by.
Limit: 10 labels

labels
string | null

Types of discounts to search for Product, Shipping, or All
when not specified, all types are returned.

array of strings | null

List of location codes to filter discounts by.
when not specified all discounts are returned.

locationCodes
Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain