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

DiscountCodeApplication object

Version unstable

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

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.

Implements

Version 2021-07 (Release candidate)

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

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.

Implements

Version 2021-04 (Latest)

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

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.

Implements

Version 2021-01

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

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.

Implements

Version 2020-10

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

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.

Implements

Version 2020-07

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

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.

Implements

Version 2020-04

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

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.

Implements

Version 2020-01 (Unsupported)

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

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.

Implements

Version 2019-10 (Unsupported)

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

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.

Implements

Version 2019-07 (Unsupported)

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

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.

Implements

Version 2019-04 (Unsupported)

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

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.

Implements