checkoutAttributesUpdateV2 mutation

Updates the attributes of a checkout.

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.

input ( CheckoutAttributesUpdateV2Input! ) required

The checkout attributes to update.

CheckoutAttributesUpdateV2Input fields

allowPartialAddresses (Boolean)

Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of the addresses is still done at complete time.

customAttributes ([AttributeInput!])

A list of extra information that is added to the checkout.

note (String)

The text of an optional note that a shop owner can attach 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

Updates the attributes of a checkout.

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.

input ( CheckoutAttributesUpdateV2Input! ) required

The checkout attributes to update.

CheckoutAttributesUpdateV2Input fields

allowPartialAddresses (Boolean)

Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of the addresses is still done at complete time.

customAttributes ([AttributeInput!])

A list of extra information that is added to the checkout.

note (String)

The text of an optional note that a shop owner can attach 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

Updates the attributes of a checkout.

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.

input ( CheckoutAttributesUpdateV2Input! ) required

The checkout attributes to update.

CheckoutAttributesUpdateV2Input fields

allowPartialAddresses (Boolean)

Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of the addresses is still done at complete time.

customAttributes ([AttributeInput!])

A list of extra information that is added to the checkout.

note (String)

The text of an optional note that a shop owner can attach 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