Anchor to section titled 'undefined'

checkoutLineItemsAdd
mutation
deprecated

Requires unauthenticated_write_checkouts access scope.

Adds 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 add to the checkout.

The input must not contain more than 250 values.

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

CheckoutLineItemsAddPayload returns

Anchor to CheckoutLineItemsAddPayload.checkout
checkout
Checkout

The updated checkout object.

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

The list of errors that occurred from executing the mutation.

Anchor to CheckoutLineItemsAddPayload.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 checkoutLineItemsAdd($checkoutId: ID!, $lineItems: [CheckoutLineItemInput!]!) {
  checkoutLineItemsAdd(checkoutId: $checkoutId, lineItems: $lineItems) {
    checkout {
      # Checkout fields
    }
    checkoutUserErrors {
      # CheckoutUserError 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!
}