DiscountCodeApplication

Version 2019-04

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Show definition
"""
Discount code applications capture the intentions of a discount code at
the time that it is applied onto an order.
"""
type DiscountCodeApplication implements DiscountApplication {
  """
  The method by which the discount's value is allocated to its entitled items.
  """
  allocationMethod: DiscountApplicationAllocationMethod!
  """
  The string identifying the discount code that was used at the time of application.
  """
  code: String!
  """
  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 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.

code (String!)

The string identifying the discount code that was used at the time of application.

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.

value (PricingValue!)

The value of the discount application.

Version 2019-07 (Latest)

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Show definition
"""
Discount code applications capture the intentions of a discount code at
the time that it is applied onto an order.
"""
type DiscountCodeApplication implements DiscountApplication {
  """
  The method by which the discount's value is allocated to its entitled items.
  """
  allocationMethod: DiscountApplicationAllocationMethod!
  """
  The string identifying the discount code that was used at the time of application.
  """
  code: String!
  """
  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 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.

code (String!)

The string identifying the discount code that was used at the time of application.

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.

value (PricingValue!)

The value of the discount application.

Version 2019-10 (Release candidate)

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Show definition
"""
Discount code applications capture the intentions of a discount code at
the time that it is applied onto an order.
"""
type DiscountCodeApplication implements DiscountApplication {
  """
  The method by which the discount's value is allocated to its entitled items.
  """
  allocationMethod: DiscountApplicationAllocationMethod!
  """
  The string identifying the discount code that was used at the time of application.
  """
  code: String!
  """
  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 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.

code (String!)

The string identifying the discount code that was used at the time of application.

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.

value (PricingValue!)

The value of the discount application.

Sign up for a Partner account to get started.

Sign up