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
}Retrieves a non-public discount by discountId. These can only be accessed by users with the Discount Read behavior.
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
}JWT Authorization header using the Bearer scheme.
The ID of the discount
limits which fields are returned in the response body
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.
Unique identifier of the discount. System-supplied and read-only.
Unique identifier of the discount.
Name of the discount.
Friendly description of the discount.
Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: "Percentage," "Amount," and "Free".
Show child attributes
Show child attributes
When the discount expires. If null, there's no expiration date.