Anchor to section titled 'undefined'

checkoutLineItemsReplace
mutation
deprecated

Requires unauthenticated_write_checkouts access scope.

Sets a list of line items to a checkout. 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 lineItems
lineItems
[CheckoutLineItemInput!]!
required

A list of line item objects to set on the checkout.

The input must not contain more than 250 values.

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

CheckoutLineItemsReplacePayload returns

Anchor to CheckoutLineItemsReplacePayload.checkout
checkout
Checkout

The updated checkout object.

Anchor to CheckoutLineItemsReplacePayload.userErrors
userErrors
[CheckoutUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation checkoutLineItemsReplace($checkoutId: ID!, $lineItems: [CheckoutLineItemInput!]!) {
  checkoutLineItemsReplace(checkoutId: $checkoutId, lineItems: $lineItems) {
    checkout {
      # Checkout fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "checkoutId": "gid://shopify/<objectName>/10079785100",
  "lineItems": [
    {
      "customAttributes": [
        {
          "key": "<your-key>",
          "value": "<your-value>"
        }
      ],
      "quantity": 1,
      "variantId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}
input CheckoutLineItemInput {
  customAttributes: [AttributeInput!]
  quantity: Int!
  variantId: ID!
}

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