A valid request URL is required to generate request examples{
"type": "<string>",
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"categories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedCategories": [
{
"id": 123
}
],
"products": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
],
"doNotApplyToHandlingFees": true,
"maximumQuantityPerRedemption": 123,
"appliesToLeastExpensiveProductsFirst": true
}Update Discount Target
Modifies properties of the discount target, for example, the dollar amount, or percentage off the price.
A valid request URL is required to generate request examples{
"type": "<string>",
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"categories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedCategories": [
{
"id": 123
}
],
"products": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
],
"doNotApplyToHandlingFees": true,
"maximumQuantityPerRedemption": 123,
"appliesToLeastExpensiveProductsFirst": true
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the discount. System-supplied and read-only.
Query Parameters
limits which fields are returned in the response body
Body
Properties of the discount target to modify. Required properties: Target.Type. Any unspecified properties are set to null and boolean variables to false.
What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply.
Type of target to which the discount applies. Possible values: <pre>Product</pre> or <pre>Shipping</pre>.If this is a
Product
Shipping
If yes, the discount applies to all products sold on the storefront.
Applies to Included categories When Any, the target product can belong to any specified category. When All, the target product must belong to all specified categories. Defaults to Any
List of categories to discount. When a discount applies to a category, all products in the category are discounted.
Show child attributes
Show child attributes
Applies to Included categories Defaults to Any
List of categories to exclude from the discount. Useful to exclude specific child categories.
Show child attributes
Show child attributes
List of products that are eligible for the discount.
Show child attributes
Show child attributes
List of products that are excluded from the discount.
Show child attributes
Show child attributes
Prevents order scoped discounts from layering over items that already have a shipping discount with the same type.
Prevents order scoped discounts from layering over items that already have a product discount with the same type.
Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings.
Show child attributes
Show child attributes
Shipping Zones that are applicable for this discount
Show child attributes
Show child attributes
Prevents the discount from being applied to handling fees
When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order.
if multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated
condition.
If no condition is specified then this value is not used.
If null and condition exists, then defaults to 1.
Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true)
Applies to discounts where target is not a specific product or list of products.
May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive.
Response
Success
What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply.
Type of target to which the discount applies. Possible values: <pre>Product</pre> or <pre>Shipping</pre>.If this is a
Product
Shipping
If yes, the discount applies to all products sold on the storefront.
Applies to Included categories When Any, the target product can belong to any specified category. When All, the target product must belong to all specified categories. Defaults to Any
List of categories to discount. When a discount applies to a category, all products in the category are discounted.
Show child attributes
Show child attributes
Applies to Included categories Defaults to Any
List of categories to exclude from the discount. Useful to exclude specific child categories.
Show child attributes
Show child attributes
List of products that are eligible for the discount.
Show child attributes
Show child attributes
List of products that are excluded from the discount.
Show child attributes
Show child attributes
Prevents order scoped discounts from layering over items that already have a shipping discount with the same type.
Prevents order scoped discounts from layering over items that already have a product discount with the same type.
Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings.
Show child attributes
Show child attributes
Shipping Zones that are applicable for this discount
Show child attributes
Show child attributes
Prevents the discount from being applied to handling fees
When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order.
if multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated
condition.
If no condition is specified then this value is not used.
If null and condition exists, then defaults to 1.
Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true)
Applies to discounts where target is not a specific product or list of products.
May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive.