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

ScriptDiscountApplication object

Version unstable

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2021-07 (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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2021-04 (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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2021-01

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2020-10

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2020-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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2020-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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2020-01 (Unsupported)

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2019-10 (Unsupported)

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2019-07 (Unsupported)

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead

Version 2019-04 (Unsupported)

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

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

  • How the discount amount is distributed on the discounted lines.

  • 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

  • description (String!) deprecated

    The description of the application as defined by the Script.

    Deprecation warning

    Use title instead