ScriptDiscountApplication

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.

Show definition
# 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.
type ScriptDiscountApplication implements DiscountApplication {
  # The method by which the discount's value is allocated to its entitled items.
  allocationMethod: DiscountApplicationAllocationMethod!

  # An ordered index which can be used to identify the discount application and indicate the precedence
  # of the discount application for calculations.
  index: Int!

  # Which lines of targetType on the order that the discount is allocated over.
  targetSelection: DiscountApplicationTargetSelection!

  # The type of line on the order that the discount is applicable towards.
  targetType: DiscountApplicationTargetType!

  # The value of the discount application.
  value: PricingValue!

  # The description of the application as defined by the Script.
  description: String!
}

Implements

Fields

allocationMethod   (DiscountApplicationAllocationMethod!)

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

description   (String!)

The description of the application as defined by the Script.

index   (Int!)

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

targetSelection   (DiscountApplicationTargetSelection!)

Which lines of targetType on the order that the discount is allocated over.

targetType   (DiscountApplicationTargetType!)

The type of line on the order that the discount is applicable towards.

value   (PricingValue!)

The value of the discount application.