Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
discounts
/
code
/
{code}
Error
A valid request URL is required to generate request examples
{
  "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
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

Name of the discount that can be applied and its expiration date. The discount can be on a single product or the entire order.

discountId
integer<int32>

Unique identifier of the discount. System-supplied and read-only.

code
string | null

Unique identifier of the discount.

name
string | null

Name of the discount.

friendlyDescription
string | null

Friendly description of the discount.

amount
number<double>
scope
string | null
maxRedemptions
integer<int32> | null
maximumUsesPerUser
integer<int32> | null
requiresAuthenticatedUser
boolean
doesNotApplyToProductsWithSalePrice
boolean
maximumRedemptionsPerOrder
integer<int32> | null
maximumDiscountValuePerOrder
number<double> | null
maxDiscountValuePerRedemption
number<double> | null
doesNotApplyToMultiShipToOrders
boolean | null
includedPriceLists
string[] | null
redemptions
integer<int32>
isPublic
boolean | null
labels
string[] | null
type
string | null
amountType
string | null

Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: "Percentage," "Amount," and "Free".

target
object
condition
object
expirationDate
string<date-time> | null
deprecated

When the discount expires. If null, there's no expiration date.

stackingLayer
integer<int32>