AutomaticDiscountApplication

Version 2019-07 (Latest)

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

Show definition
"""
Automatic discount applications capture the intentions of a discount that was automatically applied.
"""
type AutomaticDiscountApplication implements DiscountApplication {
  """
  The method by which the discount's value is allocated to its entitled items.
  """
  allocationMethod: DiscountApplicationAllocationMethod!
  """
  An ordered index that can be used to identify the discount application and indicate the precedence
  of the discount application for calculations.
  """
  index: Int!
  """
  How the discount amount is distributed on the discounted lines.
  """
  targetSelection: DiscountApplicationTargetSelection!
  """
  Whether the discount is applied on line items or shipping lines.
  """
  targetType: DiscountApplicationTargetType!
  """
  The title of the discount application.
  """
  title: String!
  """
  The value of the discount application.
  """
  value: PricingValue!
}

Implements

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 discount application.

value (PricingValue!)

The value of the discount application.

Version 2019-10 (Release candidate)

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

Show definition
"""
Automatic discount applications capture the intentions of a discount that was automatically applied.
"""
type AutomaticDiscountApplication implements DiscountApplication {
  """
  The method by which the discount's value is allocated to its entitled items.
  """
  allocationMethod: DiscountApplicationAllocationMethod!
  """
  An ordered index that can be used to identify the discount application and indicate the precedence
  of the discount application for calculations.
  """
  index: Int!
  """
  How the discount amount is distributed on the discounted lines.
  """
  targetSelection: DiscountApplicationTargetSelection!
  """
  Whether the discount is applied on line items or shipping lines.
  """
  targetType: DiscountApplicationTargetType!
  """
  The title of the discount application.
  """
  title: String!
  """
  The value of the discount application.
  """
  value: PricingValue!
}

Implements

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 discount application.

value (PricingValue!)

The value of the discount application.

Sign up for a Partner account to get started.

Sign up