discountCodeFreeShippingCreate mutation

Creates a free shipping code discount.

Required access

Apps must have write_discounts access scope.

On this page

• Interactive example
• Arguments
• DiscountCodeFreeShippingInput fields
• Return fields

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.

<font style="color:#1F61A0;">codeDiscountNode</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">code</font>
  <font style="color:#1F61A0;">extraInfo</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

DiscountCodeFreeShippingInput fields

• appliesOnOneTimePurchase ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the discount applies on regular one-time-purchase items.
• appliesOnSubscription ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the discount applies on subscription items.
• appliesOncePerCustomer ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the discount can be applied only once per customer.
• code ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The code to use the discount.
• customerSelection ([DiscountCustomerSelectionInput](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcustomerselectioninput))
  The customers that can use the discount.
• destination ([DiscountShippingDestinationSelectionInput](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountshippingdestinationselectioninput))
  A list of destinations where the discount will apply.
• endsAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date and time when the discount ends. For open-ended discounts, use null.
• maximumShippingPrice ([Decimal](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01))
  The maximum shipping price that qualifies for the discount.
• minimumRequirement ([DiscountMinimumRequirementInput](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountminimumrequirementinput))
  The minimum subtotal or quantity that’s required for the discount to be applied.
• recurringCycleLimit ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The number of times a discount applies on recurring purchases (subscriptions).
• startsAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date and time when the discount starts.
• title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The title of the discount.
• usageLimit ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The maximum number of times that the discount can be used. For open-ended discounts, use null.

Return fields

• codeDiscountNode ([DiscountCodeNode](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodenode))
  The created code discount.
• userErrors ([[DiscountUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountusererror))
  List of errors that occurred executing the mutation.