Appearance

pos-update-cart ​

Method: POST
Path: /pos/carts/{id}/items

Tags: POS

Summary ​

Add/delete cart item

Description ​

Add Item to cart. To delete item from cart, pass quantity = 0

Pos SDK Usage ​

SDK Method: pos.updateCart()

Example:

typescript
// Add item to cart
const { data, error } = await pos.updateCart(
  { id: "01H9CART12345ABCDE" },
  {
    product_id: "01H9XYZ12345ABCDE",
    variant_id: null,
    quantity: 3
  }
);

if (error) {
  console.error("Failed to update cart:", error.message);
} else {
  console.log("Cart updated:", data.cart.cart_items.length);
}

// Remove item from cart (set quantity to 0)
const { data: removeData, error: removeError } = await pos.updateCart(
  { id: "01H9CART12345ABCDE" },
  {
    product_id: "01H9XYZ12345ABCDE",
    variant_id: null,
    quantity: 0
  }
);

TypeScript Definition ​

typescript
"pos-update-cart": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description cart id */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["UpdateCartItem"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            cart: components["schemas"]["Cart"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References ​

ReferenceResolves To
components["schemas"]["UpdateCartItem"]UpdateCartItem
components["schemas"]["Cart"]Cart
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized
components["responses"]["NotFound"]NotFound

Parameters ​

  • id (path): cart id

Request Body ​

Content Types: application/json

Responses ​

200 ​

OK

400 ​

Bad request

401 ​

Not authorized for given operation on the Resource

404 ​

Requested resource not found

OpenAPI Definition ​

json
{
  "tags": [
    "POS"
  ],
  "operationId": "pos-update-cart",
  "summary": "Add/delete cart item",
  "description": "Add Item to cart. To delete item from cart, pass quantity = 0",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "cart id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/UpdateCartItem"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "cart": {
                    "$ref": "#/components/schemas/Cart"
                  }
                },
                "required": [
                  "cart"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "updateCart"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: