Get Item Discounts

POST

commerce

catalog

storefront

discounts

products

Error

A valid request URL is required to generate request examples

{
  "discounts": [
    {
      "amount": 123,
      "amountType": "<string>",
      "canBeStackedUpon": true,
      "code": "<string>",
      "conditions": {
        "categoriesToExcludeFromMinOrderTotal": [
          {
            "categoryId": 123
          }
        ],
        "continuityRecurrenceSettings": {
          "interval": 123,
          "startOrdinal": 123,
          "stopOrdinal": 123
        },
        "couponCode": "<string>",
        "customerSegments": [
          {
            "id": 123
          }
        ],
        "excludedCategories": [
          {
            "categoryId": 123
          }
        ],
        "excludedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "exclusiveLocationCodes": [
          "<string>"
        ],
        "exclusiveSiteIds": [
          123
        ],
        "includedCategories": [
          {
            "categoryId": 123
          }
        ],
        "includedPaymentWorkflows": [
          "<string>"
        ],
        "includedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "maxRedemptionCount": 123,
        "maximumOrderAmount": 123,
        "minDistinctProductsRequired": 123,
        "minTotalOrderQuantity": 123,
        "minimumCategorySubtotalBeforeDiscounts": 123,
        "minimumLifetimeValueAmount": 123,
        "minimumOrderAmount": 123,
        "minimumQuantityProductsRequiredInCategories": 123,
        "minimumQuantityRequiredProducts": 123,
        "minimumRequiredQuantityPerRedemption": 123,
        "productsToExcludeFromMinOrderTotal": [
          {
            "productCode": "<string>"
          }
        ],
        "requiresAuthenticatedUser": true,
        "requiresCoupon": true,
        "validFulfillmentMethods": [
          "<string>"
        ],
        "validSubscriptionContinuityOrdinals": [
          123
        ],
        "validSubscriptionFrequencies": [
          "<string>"
        ]
      },
      "content": {},
      "customProperties": [
        {
          "code": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "doesNotApplyToMultiShipToOrders": true,
      "doesNotApplyToProductsWithSalePrice": true,
      "doesNotApplyToSalePrice": true,
      "expirationDate": "2023-11-07T05:31:56Z",
      "hasPurchaseConditions": true,
      "id": 123,
      "includedPriceLists": [
        "<string>"
      ],
      "isBxGx": true,
      "isGroupDiscount": true,
      "isPublic": true,
      "isSubscriptionDiscount": true,
      "isUnconditional": true,
      "labels": [
        "<string>"
      ],
      "maximumDiscountImpactPerOrder": 123,
      "maximumDiscountImpactPerRedemption": 123,
      "maximumRedemptionsPerOrder": 123,
      "maximumUsesPerUser": 123,
      "preventLineItemShippingDiscounts": true,
      "preventOrderProductDiscounts": true,
      "preventOrderShippingDiscounts": true,
      "pricingContext": "<string>",
      "purchaseRequirementType": "<string>",
      "reevalFreeItemMinOrderPostDiscounts": true,
      "scope": "<string>",
      "stackingLayer": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "target": {
        "categories": [
          {
            "id": 123
          }
        ],
        "doNotApplyToHandlingFees": true,
        "excludeItemsWithExistingProductDiscounts": true,
        "excludeItemsWithExistingShippingDiscounts": true,
        "excludedCategories": [
          {
            "id": 123
          }
        ],
        "excludedCategoriesOperator": "<string>",
        "excludedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "includeAllProducts": true,
        "includedCategoriesOperator": "<string>",
        "maximumQuantityPerRedemption": 123,
        "products": [
          {
            "productCode": "<string>"
          }
        ],
        "shippingMethods": [
          {
            "code": "<string>",
            "name": "<string>"
          }
        ],
        "shippingZones": [
          {
            "zone": "<string>"
          }
        ],
        "type": "<string>"
      },
      "thresholdMessage": {
        "discountId": 123,
        "message": "<string>",
        "requiresCouponCode": true,
        "showInCart": true,
        "showOnCheckout": true,
        "thresholdValue": 123
      }
    }
  ],
  "purchaseRequirements": [
    {
      "discountIds": [
        123
      ],
      "productCode": "<string>"
    }
  ],
  "targets": [
    {
      "discountIds": [
        123
      ],
      "productCode": "<string>"
    }
  ]
}

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 discounts

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.

includeUnconditional

boolean

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

isPurchaseRequirement

boolean

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

isTarget

boolean

Set false to exclude discounts that require one of the specified products to be a target Default is true

labels

string[] | null

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

locationCodes

string[] | null

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

productCodes

string[] | null

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

targetType

string | null

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

Response

discounts

object[] | null

Show child attributes

purchaseRequirements

object[] | null

Show child attributes

targets

object[] | null

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "discounts": [
    {
      "amount": 123,
      "amountType": "<string>",
      "canBeStackedUpon": true,
      "code": "<string>",
      "conditions": {
        "categoriesToExcludeFromMinOrderTotal": [
          {
            "categoryId": 123
          }
        ],
        "continuityRecurrenceSettings": {
          "interval": 123,
          "startOrdinal": 123,
          "stopOrdinal": 123
        },
        "couponCode": "<string>",
        "customerSegments": [
          {
            "id": 123
          }
        ],
        "excludedCategories": [
          {
            "categoryId": 123
          }
        ],
        "excludedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "exclusiveLocationCodes": [
          "<string>"
        ],
        "exclusiveSiteIds": [
          123
        ],
        "includedCategories": [
          {
            "categoryId": 123
          }
        ],
        "includedPaymentWorkflows": [
          "<string>"
        ],
        "includedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "maxRedemptionCount": 123,
        "maximumOrderAmount": 123,
        "minDistinctProductsRequired": 123,
        "minTotalOrderQuantity": 123,
        "minimumCategorySubtotalBeforeDiscounts": 123,
        "minimumLifetimeValueAmount": 123,
        "minimumOrderAmount": 123,
        "minimumQuantityProductsRequiredInCategories": 123,
        "minimumQuantityRequiredProducts": 123,
        "minimumRequiredQuantityPerRedemption": 123,
        "productsToExcludeFromMinOrderTotal": [
          {
            "productCode": "<string>"
          }
        ],
        "requiresAuthenticatedUser": true,
        "requiresCoupon": true,
        "validFulfillmentMethods": [
          "<string>"
        ],
        "validSubscriptionContinuityOrdinals": [
          123
        ],
        "validSubscriptionFrequencies": [
          "<string>"
        ]
      },
      "content": {},
      "customProperties": [
        {
          "code": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "doesNotApplyToMultiShipToOrders": true,
      "doesNotApplyToProductsWithSalePrice": true,
      "doesNotApplyToSalePrice": true,
      "expirationDate": "2023-11-07T05:31:56Z",
      "hasPurchaseConditions": true,
      "id": 123,
      "includedPriceLists": [
        "<string>"
      ],
      "isBxGx": true,
      "isGroupDiscount": true,
      "isPublic": true,
      "isSubscriptionDiscount": true,
      "isUnconditional": true,
      "labels": [
        "<string>"
      ],
      "maximumDiscountImpactPerOrder": 123,
      "maximumDiscountImpactPerRedemption": 123,
      "maximumRedemptionsPerOrder": 123,
      "maximumUsesPerUser": 123,
      "preventLineItemShippingDiscounts": true,
      "preventOrderProductDiscounts": true,
      "preventOrderShippingDiscounts": true,
      "pricingContext": "<string>",
      "purchaseRequirementType": "<string>",
      "reevalFreeItemMinOrderPostDiscounts": true,
      "scope": "<string>",
      "stackingLayer": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "target": {
        "categories": [
          {
            "id": 123
          }
        ],
        "doNotApplyToHandlingFees": true,
        "excludeItemsWithExistingProductDiscounts": true,
        "excludeItemsWithExistingShippingDiscounts": true,
        "excludedCategories": [
          {
            "id": 123
          }
        ],
        "excludedCategoriesOperator": "<string>",
        "excludedProducts": [
          {
            "productCode": "<string>"
          }
        ],
        "includeAllProducts": true,
        "includedCategoriesOperator": "<string>",
        "maximumQuantityPerRedemption": 123,
        "products": [
          {
            "productCode": "<string>"
          }
        ],
        "shippingMethods": [
          {
            "code": "<string>",
            "name": "<string>"
          }
        ],
        "shippingZones": [
          {
            "zone": "<string>"
          }
        ],
        "type": "<string>"
      },
      "thresholdMessage": {
        "discountId": 123,
        "message": "<string>",
        "requiresCouponCode": true,
        "showInCart": true,
        "showOnCheckout": true,
        "thresholdValue": 123
      }
    }
  ],
  "purchaseRequirements": [
    {
      "discountIds": [
        123
      ],
      "productCode": "<string>"
    }
  ],
  "targets": [
    {
      "discountIds": [
        123
      ],
      "productCode": "<string>"
    }
  ]
}

Developers

API reference

AI Tools

Authorizations

Query Parameters

Body

Response