Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)MutationscartLinesRemove

cartLinesRemove

Removes merchandise lines from an existing cart.

Authentication

Public Access: Accessible with the public API key

Mutation Structure

mutation {
  cartLinesRemove(id: String!, lineIds: [ID]!) {
    cart {
      # Cart fields
    }
    userErrors {
      # UserError fields
    }
  }
}

Input Arguments

ArgumentTypeRequiredDescription
idStringYesThe ID of the cart to remove lines from
lineIds[ID]YesA list of line item IDs to remove from the cart

Return Type

CartLinesRemovePayload - Payload returned by the cartLinesRemove mutation. Returns the updated cart and any user errors that occurred during the operation.

Example

mutation {
  cartLinesRemove(
    id: "eyJhbGciOiJIUzI1NiJ9..."
    lineIds: ["abc123", "def456"]
  ) {
    cart {
      id
      lines {
        edges {
          node {
            id
            quantity
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}