setCart

Replace the current user's or guest's cart. 🔐 This method requires authorization (or a guest context).

Description

This method replaces the entire cart of the current context - an authorized user or a guest (resolved via the x-guest-id header, see Guest mode) - with the supplied items. It returns a Promise that resolves to the updated ICartResponse object.

Users.setCart(

body*, body.items*

);

Parameters schema

Schema

body(required): ICartSet
New cart contents. Example: { items: [{ productId: 1, qty: 2 }] }

body.items(required): ICartItem[]
New cart items.

body.items.productId(required): number
Product identifier.
example: 1

body.items.qty(required): number
Quantity of the product in the cart.
example: 2

Examples

Minimal example

const response = await Users.setCart({
  items: [{ productId: 1, qty: 2 }],
});

Example response

{
  "items": [
    {
      "productId": 1,
      "qty": 2,
      "addedAt": "2026-05-30T10:00:00.000Z"
    }
  ],
  "total": 1
}

Response schema

Schema: ICartResponse

items: ICartItem[]
Cart items.

items.productId: number
Product identifier.
example: 1

items.qty: number
Quantity of the product in the cart.
example: 2

items.addedAt: string
ISO date when the item was added.
example: "2026-05-30T10:00:00.000Z"

total: number
Total number of items in the cart.
example: 3

---