Choose a version:

CalculatedDiscountApplication

interface

Requires read_order_edits access scope or read_returns access scope.

A discount application involved in order editing that might be newly added or have new changes applied.

Anchor to FieldsFields

Anchor to allocationMethodallocationMethod •DiscountApplicationAllocationMethod! non-null: The method by which the discount's value is allocated to its entitled items.
Anchor to appliedToappliedTo •DiscountApplicationLevel! non-null: The level at which the discount was applied.
Anchor to descriptiondescription •String: The description of discount application. Indicates the reason why the discount was applied.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to targetSelectiontargetSelection •DiscountApplicationTargetSelection! non-null: How the discount amount is distributed on the discounted lines.
Anchor to targetTypetargetType •DiscountApplicationTargetType! non-null: Whether the discount is applied on line items or shipping lines.
Anchor to valuevalue •PricingValue! non-null: The value of the discount application.

Was this section helpful?

•OBJECT

A discount that is automatically applied to an order that is being edited.

Anchor to allocationMethodallocationMethod •DiscountApplicationAllocationMethod! non-null: The method by which the discount's value is allocated to its entitled items.
Anchor to appliedToappliedTo •DiscountApplicationLevel! non-null: The level at which the discount was applied.
Anchor to descriptiondescription •String: The description of discount application. Indicates the reason why the discount was applied.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to targetSelectiontargetSelection •DiscountApplicationTargetSelection! non-null: How the discount amount is distributed on the discounted lines.
Anchor to targetTypetargetType •DiscountApplicationTargetType! non-null: Whether the discount is applied on line items or shipping lines.
Anchor to valuevalue •PricingValue! non-null: The value of the discount application.

•OBJECT

A discount code that is applied to an order that is being edited.

Anchor to allocationMethodallocationMethod •DiscountApplicationAllocationMethod! non-null: The method by which the discount's value is allocated to its entitled items.
Anchor to appliedToappliedTo •DiscountApplicationLevel! non-null: The level at which the discount was applied.
Anchor to codecode •String! non-null: The string identifying the discount code that was used at the time of application.
Anchor to descriptiondescription •String: The description of discount application. Indicates the reason why the discount was applied.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to targetSelectiontargetSelection •DiscountApplicationTargetSelection! non-null: How the discount amount is distributed on the discounted lines.
Anchor to targetTypetargetType •DiscountApplicationTargetType! non-null: Whether the discount is applied on line items or shipping lines.
Anchor to valuevalue •PricingValue! non-null: The value of the discount application.

•OBJECT

Represents a discount that was manually created for an order that is being edited.

Anchor to allocationMethodallocationMethod •DiscountApplicationAllocationMethod! non-null: The method by which the discount's value is allocated to its entitled items.
Anchor to appliedToappliedTo •DiscountApplicationLevel! non-null: The level at which the discount was applied.
Anchor to descriptiondescription •String: The description of discount application. Indicates the reason why the discount was applied.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to targetSelectiontargetSelection •DiscountApplicationTargetSelection! non-null: How the discount amount is distributed on the discounted lines.
Anchor to targetTypetargetType •DiscountApplicationTargetType! non-null: Whether the discount is applied on line items or shipping lines.
Anchor to valuevalue •PricingValue! non-null: The value of the discount application.

•OBJECT

A discount created by a Shopify script for an order that is being edited.

Anchor to allocationMethodallocationMethod •DiscountApplicationAllocationMethod! non-null: The method by which the discount's value is allocated to its entitled items.
Anchor to appliedToappliedTo •DiscountApplicationLevel! non-null: The level at which the discount was applied.
Anchor to descriptiondescription •String: The description of discount application. Indicates the reason why the discount was applied.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to targetSelectiontargetSelection •DiscountApplicationTargetSelection! non-null: How the discount amount is distributed on the discounted lines.
Anchor to targetTypetargetType •DiscountApplicationTargetType! non-null: Whether the discount is applied on line items or shipping lines.
Anchor to valuevalue •PricingValue! non-null: The value of the discount application.

Was this section helpful?