Skip to main content
Anchor to DiscountCodeApplication

DiscountCodeApplication

object

Records the configuration and intent of a discount code when a customer applies it. This includes the code string, allocation method, target type, and discount value at the time of application. The applicable field indicates whether the code was successfully applied.


Note

To see the actual amounts discounted on specific line items or shipping lines, use the DiscountAllocation object instead.


•DiscountApplicationAllocationMethod!
non-null

The method by which the discount's value is allocated to its entitled items.

Show enum values
•Boolean!
non-null

Specifies whether the discount code was applied successfully.

•String!
non-null

The string identifying the discount code that was used at the time of application.

•DiscountApplicationTargetSelection!
non-null

Which lines of targetType that the discount is allocated over.

Show enum values
•DiscountApplicationTargetType!
non-null

The type of line that the discount is applicable towards.

Show enum values
•PricingValue!
non-null

The value of the discount application.

Show union types

Was this section helpful?


Was this section helpful?