Discount document (Shop API 23.1)

Document representing a discount that was either optionally applied when creating a custom price adjustment or applied by the promotion engine. The property type is mandatory; the properties amount and priceBookId are used only in association with specific types. Some examples:
Property Type Constraints Description
amount Decimal   The amount that is used with the amount and fixed price types.
percentage Decimal   The percentage that is used with percentage types.
price_book_id String   The price book id that is used with some types.
type Enum {percentage, fixed_price, amount, free, price_book_price, bonus, total_fixed_price, bonus_choice, percentage_off_options} mandatory=true, nullable=false The type of discount.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.