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

discountCodeBxgyCreate mutation

Version unstable

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2021-01 (Release candidate)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-10 (Latest)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-07

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-04

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-01

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-10 (Unsupported)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-07 (Unsupported)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-04 (Unsupported)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required

The input data used to create the code discount.

DiscountCodeBxgyInput fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.
code (String)

The code to use the discount.
customerBuys (DiscountCustomerBuysInput)

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

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

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.
title (String)

The title of the discount.
usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.
usesPerOrderLimit (Int)

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

Return fields

codeDiscountNode (DiscountCodeNode)

The created code discount.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.