Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

id
integer<int32>
required

The ID of the discount

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

OK

Represents a discount for runtime API.

amount
number<double> | null

Must be either null or greater than zero.

amountType
string | null

Gets or sets the AmountType of the discount. Values: Percentage, Amount, FixedPrice, FreeAutoAdd

canBeStackedUpon
boolean | null

Indicates whether or not stacking is enabled for this discount

code
string | null

Gets or sets the code associated with the discount.

conditions
object
content
object | null

Gets or sets the content of the discount.

customProperties
object[] | null

Gets or sets the custom properties of the discount.

doesNotApplyToMultiShipToOrders
boolean | null

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

doesNotApplyToProductsWithSalePrice
boolean | null

Determines whether a discount applies to 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 that 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.

expirationDate
string<date-time> | null

Gets or sets the expiration date of the discount.

hasPurchaseConditions
boolean

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

id
integer<int32>

Gets or sets the unique identifier for the discount.

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.

isGroupDiscount
boolean

When set to true then the discount is applied to all of the target items once the minimum quantity per redemption is met.

isPublic
boolean | null

Gets or sets a value indicating whether the discount is public.

isSubscriptionDiscount
boolean | null

Gets or sets a value indicating whether the discount is a subscription discount.

isUnconditional
boolean

Gets or sets a value indicating whether the discount is unconditional.

labels
string[] | null

List of distinct labels associated with the discount.

maximumDiscountImpactPerOrder
number<double> | null

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

maximumDiscountImpactPerRedemption
number<double> | null

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

maximumRedemptionsPerOrder
integer<int32> | null

Maximum number of redemptions for the discount per registered user.

maximumUsesPerUser
integer<int32> | null

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

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

pricingContext
string | null

The pricing context this discount is applicable to. Values: Any, OnlinePurchase, ContinuityOrder

purchaseRequirementType
string | null

Used to determin how discount is evaluated. When set to TargetOnly, then only the Target is used to drive the purchase requirement. When set to Combination, then the Target and Condition are used to drive the purchase requirement.

reevalFreeItemMinOrderPostDiscounts
boolean | null

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

scope
string | null

Gets or sets the scope of the discount. Values: Order, LineItem

stackingLayer
integer<int32> | null

Indicates which stacking layer this discount is a part of

startDate
string<date-time> | null

Gets or sets the start date of the discount.

target
object
thresholdMessage
object