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

DiscountApplication object

Version unstable

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return DiscountApplication

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplication

Version unstable

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

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.

Types that implement DiscountApplication

Version 2021-01 (Release candidate)

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2021-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.

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.

Types that implement DiscountApplication

Version 2020-10 (Latest)

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2020-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.

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.

Types that implement DiscountApplication

Version 2020-07

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2020-07

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

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.

Types that implement DiscountApplication

Version 2020-04

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2020-04

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

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.

Types that implement DiscountApplication

Version 2020-01

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2020-01

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

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.

Types that implement DiscountApplication

Version 2019-10 (Unsupported)

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2019-10 (Unsupported)

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

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.

Types that implement DiscountApplication

Version 2019-07 (Unsupported)

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2019-07 (Unsupported)

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

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.

Types that implement DiscountApplication

Version 2019-04 (Unsupported)

On this page

Fields

edges ([DiscountApplicationEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-04 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DiscountApplication!)

The item at the end of DiscountApplicationEdge.

Types that return DiscountApplicationEdge

Version 2019-04 (Unsupported)

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

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.

Types that implement DiscountApplication