DiscountCodeBasic object

Version 2020-10 (Release candidate)

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.

Version 2020-07 (Latest)

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.

Version 2020-04

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.

Version 2020-01

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.

Version 2019-10

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.

Version 2019-07 (Unsupported)

A basic 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.

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.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of 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.

usageLimit (Int)

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

Mutations for DiscountCodeBasic

discountCodeBasicCreate

Creates a basic code discount.

discountCodeBasicUpdate

Updates a basic code discount.