API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

CalculatedDiscountCodeApplication object

Version unstable

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Required access

read_order_edits access scope.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

appliedTo (DiscountApplicationLevel!)

The level at which the discount was applied.

code (String!)

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

description (String)

The description of discount application. Indicates the reason why the discount was applied.

id (ID!)

Globally unique identifier.

targetSelection (DiscountApplicationTargetSelection!)

How the discount amount is distributed on the discounted lines.

targetType (DiscountApplicationTargetType!)

Whether the discount is applied on line items or shipping lines.

value (PricingValue!)

The value of the discount application.

Implements

Version 2021-01 (Release candidate)

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Required access

read_order_edits access scope.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

appliedTo (DiscountApplicationLevel!)

The level at which the discount was applied.

code (String!)

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

description (String)

The description of discount application. Indicates the reason why the discount was applied.

id (ID!)

Globally unique identifier.

targetSelection (DiscountApplicationTargetSelection!)

How the discount amount is distributed on the discounted lines.

targetType (DiscountApplicationTargetType!)

Whether the discount is applied on line items or shipping lines.

value (PricingValue!)

The value of the discount application.

Implements

Version 2020-10 (Latest)

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Required access

read_order_edits access scope.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

appliedTo (DiscountApplicationLevel!)

The level at which the discount was applied.

code (String!)

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

description (String)

The description of discount application. Indicates the reason why the discount was applied.

id (ID!)

Globally unique identifier.

targetSelection (DiscountApplicationTargetSelection!)

How the discount amount is distributed on the discounted lines.

targetType (DiscountApplicationTargetType!)

Whether the discount is applied on line items or shipping lines.

value (PricingValue!)

The value of the discount application.

Implements