Anchor to section titled 'undefined'

checkoutAttributesUpdateV2
mutation
deprecated

Requires unauthenticated_write_checkouts access scope.

Updates the attributes of a checkout if allowPartialAddresses is true. The Storefront GraphQL Checkout API is deprecated and will be removed in a future version. Please see https://shopify.dev/changelog/deprecation-of-checkout-apis for more information.

Anchor to section titled 'Arguments'

Arguments

Anchor to checkoutId
checkoutId
ID!
required

The ID of the checkout.

Anchor to input
input
CheckoutAttributesUpdateV2Input!
required

The checkout attributes to update.

Was this section helpful?
Anchor to section titled 'CheckoutAttributesUpdateV2Payload returns'

CheckoutAttributesUpdateV2Payload returns

Anchor to CheckoutAttributesUpdateV2Payload.checkout
checkout
Checkout

The updated checkout object.

Anchor to CheckoutAttributesUpdateV2Payload.checkoutUserErrors
checkoutUserErrors
[CheckoutUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CheckoutAttributesUpdateV2Payload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use checkoutUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation checkoutAttributesUpdateV2($checkoutId: ID!, $input: CheckoutAttributesUpdateV2Input!) {
  checkoutAttributesUpdateV2(checkoutId: $checkoutId, input: $input) {
    checkout {
      # Checkout fields
    }
    checkoutUserErrors {
      # CheckoutUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "checkoutId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "allowPartialAddresses": true,
    "customAttributes": [
      {
        "key": "<your-key>",
        "value": "<your-value>"
      }
    ],
    "note": "<your-note>"
  }
}
input CheckoutAttributesUpdateV2Input {
  allowPartialAddresses: Boolean
  customAttributes: [AttributeInput!]
  note: String
}

input AttributeInput {
  key: String!
  value: String!
}