checkoutAttributesUpdateV2 mutation

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Updates the attributes of a checkout if allowPartialAddresses is true.

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.

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 completion time. Defaults to false with each operation.

  • 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!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead