Required access

unauthenticated_write_checkouts access scope

Applies a gift card to an existing checkout using a gift card code.

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.


Argument Type Default Description
checkoutId required ID!

The ID of the checkout.

giftCardCode required String!

The code of the gift card to apply on the checkout.

Return Fields

checkout   (Checkout!)

The updated checkout object.

userErrors   ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up