DiscountApplication

Version 2019-04

Discount applications capture the intentions of a discount source at the time of application on an order's line items or shipping lines.

Show definition
"""
Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines.
"""
interface 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 value of the discount application.
  """
  value: PricingValue!
}

Possible types

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.

value (PricingValue!)

The value of the discount application.

Version 2019-07

Discount applications capture the intentions of a discount source at the time of application on an order's line items or shipping lines.

Show definition
"""
Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines.
"""
interface 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 value of the discount application.
  """
  value: PricingValue!
}

Possible types

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.

value (PricingValue!)

The value of the discount application.

Version 2019-10 (Latest)

Discount applications capture the intentions of a discount source at the time of application on an order's line items or shipping lines.

Show definition
"""
Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines.
"""
interface 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 value of the discount application.
  """
  value: PricingValue!
}

Possible types

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.

value (PricingValue!)

The value of the discount application.

Version 2020-01 (Release candidate)

Discount applications capture the intentions of a discount source at the time of application on an order's line items or shipping lines.

Show definition
"""
Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines.
"""
interface 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 value of the discount application.
  """
  value: PricingValue!
}

Possible types

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.

value (PricingValue!)

The value of the discount application.

Sign up for a Partner account to get started.

Sign up