API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ManualDiscountApplication object

Version unstable

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2021-01 (Release candidate)

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2020-10 (Latest)

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2020-07

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2020-04

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2020-01

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2019-10 (Unsupported)

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2019-07 (Unsupported)

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements

Version 2019-04 (Unsupported)

Manual discount applications capture the intentions of a discount that was manually created for an order.

Fields

allocationMethod (DiscountApplicationAllocationMethod!)

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

description (String)

The description of the discount 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.

title (String!)

The title of the discount application.

value (PricingValue!)

The value of the discount application.

Implements