Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
discounts
/
orders
Error
A valid request URL is required to generate request examples
[
  {
    "discounts": [
      {
        "discountId": 123,
        "code": "<string>",
        "name": "<string>",
        "friendlyDescription": "<string>",
        "amount": 123,
        "scope": "<string>",
        "maxRedemptions": 123,
        "maximumUsesPerUser": 123,
        "requiresAuthenticatedUser": true,
        "doesNotApplyToProductsWithSalePrice": true,
        "maximumRedemptionsPerOrder": 123,
        "maximumDiscountValuePerOrder": 123,
        "maxDiscountValuePerRedemption": 123,
        "doesNotApplyToMultiShipToOrders": true,
        "includedPriceLists": [
          "<string>"
        ],
        "redemptions": 123,
        "isPublic": true,
        "labels": [
          "<string>"
        ],
        "type": "<string>",
        "amountType": "<string>",
        "target": {
          "type": "<string>",
          "includedCategoryIds": [
            123
          ],
          "excludedCategoryIds": [
            123
          ],
          "includedCategoriesOperator": "<string>",
          "excludedCategoriesOperator": "<string>",
          "includedProductCodes": [
            "<string>"
          ],
          "excludedProductCodes": [
            "<string>"
          ],
          "includeAllProducts": true,
          "shippingMethods": [
            "<string>"
          ],
          "shippingZones": [
            "<string>"
          ]
        },
        "condition": {
          "requiresCoupon": true,
          "couponCode": "<string>",
          "minimumQuantityProductsRequiredInCategories": 123,
          "includedCategoryIds": [
            123
          ],
          "excludedCategoryIds": [
            123
          ],
          "minimumQuantityRequiredProducts": 123,
          "includedProductCodes": [
            "<string>"
          ],
          "excludedProductCodes": [
            "<string>"
          ],
          "paymentWorkflows": [
            "<string>"
          ],
          "customerSegmentIds": [
            123
          ],
          "minimumOrderAmount": 123,
          "maximumOrderAmount": 123,
          "minimumLifetimeValueAmount": 123,
          "startDate": "2023-11-07T05:31:56Z",
          "expirationDate": "2023-11-07T05:31:56Z",
          "minimumCategorySubtotalBeforeDiscounts": 123,
          "minDistinctProductsRequired": 123
        },
        "expirationDate": "2023-11-07T05:31:56Z",
        "stackingLayer": 123
      }
    ],
    "targets": [
      {
        "productCode": "<string>",
        "discountIds": [
          123
        ]
      }
    ],
    "purchaseRequirements": [
      {
        "productCode": "<string>",
        "discountIds": [
          123
        ]
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Request parameters to search for order level discounts

productCodes
string[] | null

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

isPurchaseRequirement
boolean

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

includeUnconditional
boolean

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

customerSegmentIds
integer<int32>[] | 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.

labels
string[] | null

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

targetType
string | null

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

locationCodes
string[] | null

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

Response

Success

discounts
object[] | null
targets
object[] | null
purchaseRequirements
object[] | null