ScriptDiscountApplication object

Version 2020-01 (Release candidate)

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.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

index (Int!)

An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.

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.

title (String!)

The title of the application as defined by the Script.

value (PricingValue!)

The value of the discount application.

Implements

Deprecated fields

Show/Hide
description (String!) deprecated

The description of the application as defined by the Script.

Deprecation warning

Use title instead

Version 2019-10 (Latest)

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.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

index (Int!)

An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.

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.

title (String!)

The title of the application as defined by the Script.

value (PricingValue!)

The value of the discount application.

Implements

Deprecated fields

Show/Hide
description (String!) deprecated

The description of the application as defined by the Script.

Deprecation warning

Use title instead

Version 2019-07

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.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

index (Int!)

An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.

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.

title (String!)

The title of the application as defined by the Script.

value (PricingValue!)

The value of the discount application.

Implements

Deprecated fields

Show/Hide
description (String!) deprecated

The description of the application as defined by the Script.

Deprecation warning

Use title instead

Version 2019-04

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.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

index (Int!)

An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.

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.

title (String!)

The title of the application as defined by the Script.

value (PricingValue!)

The value of the discount application.

Implements

Deprecated fields

Show/Hide
description (String!) deprecated

The description of the application as defined by the Script.

Deprecation warning

Use title instead

Sign up for a Partner account to get started.

Sign up