checkoutDiscountCodeApplyV2

Applies a discount to an existing checkout using a discount code.

Required access

unauthenticated_write_checkouts 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

checkoutId ( ID! ) required

The ID of the checkout.

discountCode ( String! ) required

The discount code to apply to the checkout.

Return Fields

checkout (Checkout)

The updated checkout object.

checkoutUserErrors ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use checkoutUserErrors instead

Applies a discount to an existing checkout using a discount code.

Required access

unauthenticated_write_checkouts 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

checkoutId ( ID! ) required

The ID of the checkout.

discountCode ( String! ) required

The discount code to apply to the checkout.

Return Fields

checkout (Checkout)

The updated checkout object.

checkoutUserErrors ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use checkoutUserErrors instead

Sign up for a Partner account to get started.

Sign up