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
}
]
}Retrieves non-public discounts by label. These can only be accessed by users with the Discount Read behavior.
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
}
]
}JWT Authorization header using the Bearer scheme.
The label of the discount.
limits which fields are returned in the response body
Success
Show child attributes