DiscountCodeBxgy object

Version 2020-10 (Release candidate)

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • times_used

See the detailed search syntax for more information about using filters.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string is used as the query argument.

sortKey ( DiscountCodeSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

hasTimelineComment (Boolean!)

Indicates whether there are any timeline comments on the discount.

shareableUrls ([DiscountShareableUrl!]!)

URLs that can be used to share the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

totalSales (MoneyV2)

The total sales from orders where the discount was used.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.

Version 2020-07 (Latest)

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.

Version 2020-04

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.

Version 2020-01

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.

Version 2019-10

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.

Version 2019-07 (Unsupported)

A BXGY code discount.

Required access

Apps must have read_discounts access scope.

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Mutations for DiscountCodeBxgy

discountCodeBxgyCreate

Creates a BXGY code discount.

discountCodeBxgyUpdate

Updates a BXGY code discount.