Update Discount

PUT

commerce

catalog

admin

discounts

{discountId}

Error

A valid request URL is required to generate request examples

{
  "amountType": "<string>",
  "scope": "<string>",
  "target": {
    "type": "<string>",
    "appliesToLeastExpensiveProductsFirst": true,
    "categories": [
      {
        "id": 123
      }
    ],
    "doNotApplyToHandlingFees": true,
    "excludeItemsWithExistingProductDiscounts": true,
    "excludeItemsWithExistingShippingDiscounts": true,
    "excludedCategories": [
      {
        "id": 123
      }
    ],
    "excludedCategoriesOperator": "<string>",
    "excludedProducts": [
      {
        "productCode": "<string>"
      }
    ],
    "includeAllProducts": true,
    "includedCategoriesOperator": "<string>",
    "maximumQuantityPerRedemption": 1,
    "products": [
      {
        "productCode": "<string>"
      }
    ],
    "shippingMethods": [
      {
        "code": "<string>",
        "name": "<string>"
      }
    ],
    "shippingZones": [
      {
        "zone": "<string>"
      }
    ]
  },
  "amount": 1,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "canBeDeleted": true,
  "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
    ],
    "expirationDate": "2023-11-07T05:31:56Z",
    "expression": {
      "text": "<string>",
      "tree": {
        "left": "<string>",
        "logicalOperator": "<string>",
        "nodes": "<array>",
        "operator": "<string>",
        "right": "<unknown>",
        "type": "<string>"
      }
    },
    "includedCategories": [
      {
        "categoryId": 123
      }
    ],
    "includedPaymentWorkflows": [
      "<string>"
    ],
    "includedProducts": [
      {
        "productCode": "<string>"
      }
    ],
    "maxRedemptionCount": 1,
    "maximumOrderAmount": 123,
    "minDistinctProductsRequired": 123,
    "minTotalOrderQuantity": 123,
    "minimumCategorySubtotalBeforeDiscounts": 123,
    "minimumLifetimeValueAmount": 123,
    "minimumOrderAmount": 123,
    "minimumQuantityProductsRequiredInCategories": 1,
    "minimumQuantityRequiredProducts": 1,
    "minimumRequiredQuantityPerRedemption": 123,
    "pricingContext": "<string>",
    "productsToExcludeFromMinOrderTotal": [
      {
        "productCode": "<string>"
      }
    ],
    "requiresAuthenticatedUser": true,
    "requiresCoupon": true,
    "startDate": "2023-11-07T05:31:56Z",
    "validFulfillmentMethods": [
      "<string>"
    ],
    "validSubscriptionContinuityOrdinals": [
      123
    ],
    "validSubscriptionFrequencies": [
      "<string>"
    ]
  },
  "content": {
    "name": "<string>",
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "customPropertyValues": {
      "value1": "<string>",
      "value10": "<string>",
      "value2": "<string>",
      "value3": "<string>",
      "value4": "<string>",
      "value5": "<string>",
      "value6": "<string>",
      "value7": "<string>",
      "value8": "<string>",
      "value9": "<string>"
    },
    "friendlyDescription": "<string>",
    "localeCode": "<string>"
  },
  "currentRedemptionCount": 123,
  "doesNotApplyToMultiShipToOrders": true,
  "doesNotApplyToProductsWithSalePrice": true,
  "doesNotApplyToSalePrice": true,
  "hasPurchaseConditions": true,
  "id": 123,
  "includedPriceLists": [
    "<string>"
  ],
  "isBxGx": true,
  "isDisabled": true,
  "isPublic": true,
  "isSubscriptionDiscount": true,
  "labels": [
    "<string>"
  ],
  "localizedContent": [
    {
      "name": "<string>",
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "customPropertyValues": {
        "value1": "<string>",
        "value10": "<string>",
        "value2": "<string>",
        "value3": "<string>",
        "value4": "<string>",
        "value5": "<string>",
        "value6": "<string>",
        "value7": "<string>",
        "value8": "<string>",
        "value9": "<string>"
      },
      "friendlyDescription": "<string>",
      "localeCode": "<string>"
    }
  ],
  "maximumDiscountImpactPerOrder": 1,
  "maximumDiscountImpactPerRedemption": 1,
  "maximumRedemptionsPerOrder": 1,
  "maximumUsesPerUser": 1,
  "preventLineItemShippingDiscounts": true,
  "preventOrderProductDiscounts": true,
  "preventOrderShippingDiscounts": true,
  "purchaseRequirementType": "<string>",
  "reevalFreeItemMinOrderPostDiscounts": true,
  "stackingLayer": 123,
  "status": "<string>",
  "tagCodes": [
    "<string>"
  ],
  "thresholdMessage": {
    "discountId": 123,
    "thresholdValue": 123,
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "content": {
      "messageTemplate": "<string>",
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "localeCode": "<string>"
    },
    "isActive": true,
    "localizedContent": [
      {
        "messageTemplate": "<string>",
        "auditInfo": {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z"
        },
        "localeCode": "<string>"
      }
    ],
    "requiresCouponCode": true,
    "showInCart": true,
    "showOnCheckout": true
  }
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

discountId

integer<int32>

required

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

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

Properties of the discount to update. Required properties: Content.Name, AmountType, StartDate, and Target.Type. Any unspecified properties are set to null and boolean variables are set to false.

Allows you to define and manage discounts to apply to your products, product categories, or orders. The discounts can be a specified monetary amount off the price, percentage off the price, or for free shipping. You can create a coupon code that applies to the discount.

amountType

string

required

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

Minimum string length: 1

scope

string

required

Scope to which the discount applies, valid values are: Order, LineItem

Minimum string length: 1

target

object

required

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.

Show child attributes

amount

number<double> | null

Amount of the discount, as a percentage or monetary amount, for example 15% or $15.

Must be either null or greater than zero.

Required range: x > 0

auditInfo

object

Show child attributes

canBeDeleted

boolean

Signifies that the discount is not referenced and can be hard deleted

canBeStackedUpon

boolean | null

Indicates whether or not stacking is enabled for this discount

code

string | null

Indicates unique code for the discount, if not present Discount Id is used as a code.

Maximum string length: 50

Pattern: ^[A-Za-z0-9-_\.()]*[A-Za-z0-9-_()]$

conditions

object

Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together

Show child attributes

content

object

Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

Show child attributes

currentRedemptionCount

integer<int32> | null

How many times this discount has been redeemed. System-supplied and read-only.

doesNotApplyToMultiShipToOrders

boolean | null

Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts.

doesNotApplyToProductsWithSalePrice

boolean | null

Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level discounts, when true, the discount will not be applied to those items have a sale price.

doesNotApplyToSalePrice

boolean | null

Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts.

hasPurchaseConditions

boolean

Indicates if this discount has purchase conditions that must be met before the discount is applied

integer<int32> | null

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

includedPriceLists

string[] | null

Products receiving a price from a price list specified here or a child of a specified price list can be discounted.

isBxGx

boolean | null

Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts.

isDisabled

boolean | null

Signifies if the discount is disabled (Null is treated as false)

isPublic

boolean | null

Determines whether the discount is available for every shopper.

isSubscriptionDiscount

boolean | null

Determines how discounts will be evaluated for subscription items and during continuity orders.

labels

string[] | null

Indicates unique discount labels.

localizedContent

object[] | null

Show child attributes

maximumDiscountImpactPerOrder

number<double> | null

Maximum impact this discount can apply on a single order. Must be either null or greater than zero.

Required range: x > 0

maximumDiscountImpactPerRedemption

number<double> | null

Maximum impact this discount can apply on a single line item. Must be either null or greater than zero.

Required range: x > 0

maximumRedemptionsPerOrder

integer<int32> | null

Maximum number of redemptions allowed per order. If null, defaults to unlimited.

Required range: x > 0

maximumUsesPerUser

integer<int32> | null

Maximum number of times a user can redeem this discount. Must be either null or greater than zero.

Required range: x > 0

preventLineItemShippingDiscounts

boolean | null

Prevents Line Item Shipping discounts from being applied when a Line Item Product
discount has been applied

preventOrderProductDiscounts

boolean | null

Prevents Order Product discounts from being applied when a Line Item Product
or Shipping discount has been applied

preventOrderShippingDiscounts

boolean | null

Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping
or Order Product discount has been applied

purchaseRequirementType

string | null

The type of purchase requirement for this discount, either purchase conditions and targets which
Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions

reevalFreeItemMinOrderPostDiscounts

boolean | null

Enables post-order-discount minimum re-evaluation for eligible free-item discounts. Values null and false are treated as disabled.

stackingLayer

integer<int32> | null

Indicates which stacking layer this discount is a part of

status

string | null

Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.

tagCodes

string[] | null

System-supplied and read-only.

thresholdMessage

object

Show child attributes

Response

amountType

string

required

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

Minimum string length: 1

scope

string

required

Scope to which the discount applies, valid values are: Order, LineItem

Minimum string length: 1

target

object

required

Show child attributes

amount

number<double> | null

Amount of the discount, as a percentage or monetary amount, for example 15% or $15.

Must be either null or greater than zero.

Required range: x > 0

auditInfo

object

Show child attributes

canBeDeleted

boolean

Signifies that the discount is not referenced and can be hard deleted

canBeStackedUpon

boolean | null

Indicates whether or not stacking is enabled for this discount

code

string | null

Indicates unique code for the discount, if not present Discount Id is used as a code.

Maximum string length: 50

Pattern: ^[A-Za-z0-9-_\.()]*[A-Za-z0-9-_()]$

conditions

object

Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together

Show child attributes

content

object

Show child attributes

currentRedemptionCount

integer<int32> | null

How many times this discount has been redeemed. System-supplied and read-only.

doesNotApplyToMultiShipToOrders

boolean | null

Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts.

doesNotApplyToProductsWithSalePrice

boolean | null

doesNotApplyToSalePrice

boolean | null

Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts.

hasPurchaseConditions

boolean

Indicates if this discount has purchase conditions that must be met before the discount is applied

integer<int32> | null

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

includedPriceLists

string[] | null

Products receiving a price from a price list specified here or a child of a specified price list can be discounted.

isBxGx

boolean | null

Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts.

isDisabled

boolean | null

Signifies if the discount is disabled (Null is treated as false)

isPublic

boolean | null

Determines whether the discount is available for every shopper.

isSubscriptionDiscount

boolean | null

Determines how discounts will be evaluated for subscription items and during continuity orders.

labels

string[] | null

Indicates unique discount labels.

localizedContent

object[] | null

Show child attributes

maximumDiscountImpactPerOrder

number<double> | null

Maximum impact this discount can apply on a single order. Must be either null or greater than zero.

Required range: x > 0

maximumDiscountImpactPerRedemption

number<double> | null

Maximum impact this discount can apply on a single line item. Must be either null or greater than zero.

Required range: x > 0

maximumRedemptionsPerOrder

integer<int32> | null

Maximum number of redemptions allowed per order. If null, defaults to unlimited.

Required range: x > 0

maximumUsesPerUser

integer<int32> | null

Maximum number of times a user can redeem this discount. Must be either null or greater than zero.

Required range: x > 0

preventLineItemShippingDiscounts

boolean | null

Prevents Line Item Shipping discounts from being applied when a Line Item Product
discount has been applied

preventOrderProductDiscounts

boolean | null

Prevents Order Product discounts from being applied when a Line Item Product
or Shipping discount has been applied

preventOrderShippingDiscounts

boolean | null

Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping
or Order Product discount has been applied

purchaseRequirementType

string | null

The type of purchase requirement for this discount, either purchase conditions and targets which
Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions

reevalFreeItemMinOrderPostDiscounts

boolean | null

Enables post-order-discount minimum re-evaluation for eligible free-item discounts. Values null and false are treated as disabled.

stackingLayer

integer<int32> | null

Indicates which stacking layer this discount is a part of

status

string | null

Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.

tagCodes

string[] | null

System-supplied and read-only.

thresholdMessage

object

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "amountType": "<string>",
  "scope": "<string>",
  "target": {
    "type": "<string>",
    "appliesToLeastExpensiveProductsFirst": true,
    "categories": [
      {
        "id": 123
      }
    ],
    "doNotApplyToHandlingFees": true,
    "excludeItemsWithExistingProductDiscounts": true,
    "excludeItemsWithExistingShippingDiscounts": true,
    "excludedCategories": [
      {
        "id": 123
      }
    ],
    "excludedCategoriesOperator": "<string>",
    "excludedProducts": [
      {
        "productCode": "<string>"
      }
    ],
    "includeAllProducts": true,
    "includedCategoriesOperator": "<string>",
    "maximumQuantityPerRedemption": 1,
    "products": [
      {
        "productCode": "<string>"
      }
    ],
    "shippingMethods": [
      {
        "code": "<string>",
        "name": "<string>"
      }
    ],
    "shippingZones": [
      {
        "zone": "<string>"
      }
    ]
  },
  "amount": 1,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "canBeDeleted": true,
  "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
    ],
    "expirationDate": "2023-11-07T05:31:56Z",
    "expression": {
      "text": "<string>",
      "tree": {
        "left": "<string>",
        "logicalOperator": "<string>",
        "nodes": "<array>",
        "operator": "<string>",
        "right": "<unknown>",
        "type": "<string>"
      }
    },
    "includedCategories": [
      {
        "categoryId": 123
      }
    ],
    "includedPaymentWorkflows": [
      "<string>"
    ],
    "includedProducts": [
      {
        "productCode": "<string>"
      }
    ],
    "maxRedemptionCount": 1,
    "maximumOrderAmount": 123,
    "minDistinctProductsRequired": 123,
    "minTotalOrderQuantity": 123,
    "minimumCategorySubtotalBeforeDiscounts": 123,
    "minimumLifetimeValueAmount": 123,
    "minimumOrderAmount": 123,
    "minimumQuantityProductsRequiredInCategories": 1,
    "minimumQuantityRequiredProducts": 1,
    "minimumRequiredQuantityPerRedemption": 123,
    "pricingContext": "<string>",
    "productsToExcludeFromMinOrderTotal": [
      {
        "productCode": "<string>"
      }
    ],
    "requiresAuthenticatedUser": true,
    "requiresCoupon": true,
    "startDate": "2023-11-07T05:31:56Z",
    "validFulfillmentMethods": [
      "<string>"
    ],
    "validSubscriptionContinuityOrdinals": [
      123
    ],
    "validSubscriptionFrequencies": [
      "<string>"
    ]
  },
  "content": {
    "name": "<string>",
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "customPropertyValues": {
      "value1": "<string>",
      "value10": "<string>",
      "value2": "<string>",
      "value3": "<string>",
      "value4": "<string>",
      "value5": "<string>",
      "value6": "<string>",
      "value7": "<string>",
      "value8": "<string>",
      "value9": "<string>"
    },
    "friendlyDescription": "<string>",
    "localeCode": "<string>"
  },
  "currentRedemptionCount": 123,
  "doesNotApplyToMultiShipToOrders": true,
  "doesNotApplyToProductsWithSalePrice": true,
  "doesNotApplyToSalePrice": true,
  "hasPurchaseConditions": true,
  "id": 123,
  "includedPriceLists": [
    "<string>"
  ],
  "isBxGx": true,
  "isDisabled": true,
  "isPublic": true,
  "isSubscriptionDiscount": true,
  "labels": [
    "<string>"
  ],
  "localizedContent": [
    {
      "name": "<string>",
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "customPropertyValues": {
        "value1": "<string>",
        "value10": "<string>",
        "value2": "<string>",
        "value3": "<string>",
        "value4": "<string>",
        "value5": "<string>",
        "value6": "<string>",
        "value7": "<string>",
        "value8": "<string>",
        "value9": "<string>"
      },
      "friendlyDescription": "<string>",
      "localeCode": "<string>"
    }
  ],
  "maximumDiscountImpactPerOrder": 1,
  "maximumDiscountImpactPerRedemption": 1,
  "maximumRedemptionsPerOrder": 1,
  "maximumUsesPerUser": 1,
  "preventLineItemShippingDiscounts": true,
  "preventOrderProductDiscounts": true,
  "preventOrderShippingDiscounts": true,
  "purchaseRequirementType": "<string>",
  "reevalFreeItemMinOrderPostDiscounts": true,
  "stackingLayer": 123,
  "status": "<string>",
  "tagCodes": [
    "<string>"
  ],
  "thresholdMessage": {
    "discountId": 123,
    "thresholdValue": 123,
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "content": {
      "messageTemplate": "<string>",
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "localeCode": "<string>"
    },
    "isActive": true,
    "localizedContent": [
      {
        "messageTemplate": "<string>",
        "auditInfo": {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z"
        },
        "localeCode": "<string>"
      }
    ],
    "requiresCouponCode": true,
    "showInCart": true,
    "showOnCheckout": true
  }
}

Developers

API reference

AI Tools

Authorizations

Path Parameters

Query Parameters

Body

Response