Choose a version:

cartLinesAdd

mutation

Adds one or more merchandise lines to an existing Cart. Each line specifies the product variant to purchase. Quantity defaults to 1 if not provided.

You can add up to 250 lines in a single request. Use CartLineInput to configure each line's merchandise, quantity, selling plan, custom attributes, and any parent relationships for nested line items such as warranties or add-ons.

Anchor to Arguments

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to lineslines

•[CartLineInput!]!

required

A list of merchandise lines to add to the cart.

The input must not contain more than 250 values.

Was this section helpful?

Anchor to CartLinesAddPayload returnsCartLinesAddPayload returns

Anchor to cartcart •Cart: The updated cart.
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Was this section helpful?

Examples

cartLinesAdd reference

Mutation Reference

mutation cartLinesAdd($cartId: ID!, $lines: [CartLineInput!]!) {

cartLinesAdd(cartId: $cartId, lines: $lines) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"cartId": "gid://shopify/<objectName>/10079785100",

"lines": [

{

"attributes": [

{

"key": "<your-key>",

"value": "<your-value>"

}

"quantity": 1,

"merchandiseId": "gid://shopify/<objectName>/10079785100",

"sellingPlanId": "gid://shopify/<objectName>/10079785100",

"parent": {

"lineId": "gid://shopify/<objectName>/10079785100",

"merchandiseId": "gid://shopify/<objectName>/10079785100"

}

]

}

Variables

{
  "cartId": "gid://shopify/<objectName>/10079785100",
  "lines": [
    {
      "attributes": [
        {
          "key": "<your-key>",
          "value": "<your-value>"
        }
      ],
      "quantity": 1,
      "merchandiseId": "gid://shopify/<objectName>/10079785100",
      "sellingPlanId": "gid://shopify/<objectName>/10079785100",
      "parent": {
        "lineId": "gid://shopify/<objectName>/10079785100",
        "merchandiseId": "gid://shopify/<objectName>/10079785100"
      }
    }
  ]
}

Schema

input CartLineInput {
  attributes: [AttributeInput!]
  quantity: Int
  merchandiseId: ID!
  sellingPlanId: ID
  parent: CartLineParentInput
}

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

input CartLineParentInput {
  lineId: ID
  merchandiseId: ID
}