checkoutCompleteFree mutation

Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.

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

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.

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

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred from executing the mutation.

Deprecated return fields