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

Argument Description
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

Version 2021-10 (Release candidate)

Creates a BXGY code discount.

Required access

Apps must have write_discounts access scope.