Skip to main content
union

The type of value given to a customer when a discount is applied to an order. For example, the application of the discount might give the customer a percentage off a specified item. Alternatively, the application of the discount might give the customer a monetary value in a given currency off an order.

•OBJECT

A precise monetary value and its associated currency. Combines a decimal amount with a three-letter currency code to express prices, costs, and other financial values throughout the API. For example, 12.99 USD.

•Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

•CurrencyCode!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

•OBJECT

One type of value given to a customer when a discount is applied to an order. The application of a discount with this value gives the customer the specified percentage off a specified item.

•Float!
non-null

The percentage value of the object. This is a number between -100 (free) and 0 (no discount).


Was this section helpful?

Anchor to Fields with this unionFields with this union

•OBJECT

Automatic discount applications capture the intentions of a discount that was automatically applied.

•OBJECT

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

•INTERFACE

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

•OBJECT

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

•OBJECT

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

•OBJECT

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

•INTERFACE

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.

•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.

•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.

•OBJECT

The discount applied to an item that was added during the current order edit.

•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.


Was this section helpful?