Discount
Discount applications capture the intentions of a discount source at the time of application on an order's line items or shipping lines.
Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the DiscountAllocation object.
Anchor to FieldsFields
- Anchor to allocationMethodallocation•Discount
Method Application Allocation Method! non-null The method by which the discount's value is applied to its entitled items.
- Anchor to indexindex•Int!non-null
An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
- Anchor to targetSelectiontarget•Discount
Selection Application Target Selection! non-null How the discount amount is distributed on the discounted lines.
- Anchor to targetTypetarget•Discount
Type Application Target Type! non-null Whether the discount is applied on line items or shipping lines.
- Anchor to valuevalue•Pricing
Value! non-null The value of the discount application.
Anchor to Types implemented inTypes implemented in
- •OBJECT
Automatic discount applications capture the intentions of a discount that was automatically applied.
- Anchor to allocationMethodallocation•Discount
Method Application Allocation Method! non-null The method by which the discount's value is applied to its entitled items.
- Anchor to indexindex•Int!non-null
An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
- Anchor to targetSelectiontarget•Discount
Selection Application Target Selection! non-null How the discount amount is distributed on the discounted lines.
- Anchor to targetTypetarget•Discount
Type Application Target Type! non-null Whether the discount is applied on line items or shipping lines.
- Anchor to titletitle•String!non-null
The title of the discount application.
- Anchor to valuevalue•Pricing
Value! non-null The value of the discount application.
- •OBJECT
Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.
Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the DiscountAllocation object.
- Anchor to allocationMethodallocation•Discount
Method Application Allocation Method! non-null The method by which the discount's value is applied to its entitled items.
- Anchor to codecode•String!non-null
The string identifying the discount code that was used at the time of application.
- Anchor to indexindex•Int!non-null
An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
- Anchor to targetSelectiontarget•Discount
Selection Application Target Selection! non-null How the discount amount is distributed on the discounted lines.
- Anchor to targetTypetarget•Discount
Type Application Target Type! non-null Whether the discount is applied on line items or shipping lines.
- Anchor to valuevalue•Pricing
Value! non-null The value of the discount application.
- •OBJECT
Manual discount applications capture the intentions of a discount that was manually created for an order.
Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the DiscountAllocation object.
- Anchor to allocationMethodallocation•Discount
Method Application Allocation Method! non-null The method by which the discount's value is applied to its entitled items.
- Anchor to descriptiondescription•String
The description of the discount application.
- Anchor to indexindex•Int!non-null
An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
- Anchor to targetSelectiontarget•Discount
Selection Application Target Selection! non-null How the discount amount is distributed on the discounted lines.
- Anchor to targetTypetarget•Discount
Type Application Target Type! non-null Whether the discount is applied on line items or shipping lines.
- Anchor to titletitle•String!non-null
The title of the discount application.
- Anchor to valuevalue•Pricing
Value! non-null The value of the discount application.
- •OBJECT
Script discount applications capture the intentions of a discount that was created by a Shopify Script for an order's line item or shipping line.
Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the DiscountAllocation object.
- Anchor to allocationMethodallocation•Discount
Method Application Allocation Method! non-null The method by which the discount's value is applied to its entitled items.
- Anchor to indexindex•Int!non-null
An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
- Anchor to targetSelectiontarget•Discount
Selection Application Target Selection! non-null How the discount amount is distributed on the discounted lines.
- Anchor to targetTypetarget•Discount
Type Application Target Type! non-null Whether the discount is applied on line items or shipping lines.
- Anchor to titletitle•String!non-null
The title of the application as defined by the Script.
- Anchor to valuevalue•Pricing
Value! non-null The value of the discount application.
- Anchor to descriptiondescription•String!non-nullDeprecated