Cart API — Quickshops Headless REST API

The Cart endpoints let you create carts, add or update items, and clear them. All cart operations require a valid API key in the Authorization header. You should create a cart when a user begins shopping and persist the returned id in their browser session so subsequent requests can reference the same cart.

Store the cartId in the user’s browser session (e.g. a cookie or sessionStorage). You will need it for every subsequent cart operation and when creating a checkout session.

Create cart

Creates a new, empty cart for your store.

POST /cart

Request

curl -X POST https://api.quickshops.app/v1/cart \
  -H "Authorization: Bearer qk_your_key_here"

Response

{
  "data": {
    "id": "cart_01j...",
    "storeId": "store_01j...",
    "lines": [],
    "totals": {
      "subtotal": 0,
      "total": 0,
      "currency": "usd"
    }
  }
}

string

required

Unique identifier for the cart. Persist this value in the user’s session.

string

required

Identifier of the store this cart belongs to.

object[]

required

Array of cart line items. Empty on a newly created cart.

Show CartLineDto properties

string

required

Identifier of the product in this line.

number

required

Number of units of the product.

object

required

Calculated totals for the cart.

Show CartTotalsDto properties

number

required

Sum of all line item prices in the smallest currency unit (e.g. cents).

number

required

Final total after any adjustments, in the smallest currency unit.

string

required

ISO 4217 currency code in lowercase (e.g. "usd").

Get cart

Retrieves the current state of a cart.

GET /cart/:cartId

Path parameters

string

required

The ID of the cart to retrieve.

Request

curl https://api.quickshops.app/v1/cart/cart_01j... \
  -H "Authorization: Bearer qk_your_key_here"

Response

Returns a data object with the same shape as Create cart.

{
  "data": {
    "id": "cart_01j...",
    "storeId": "store_01j...",
    "lines": [
      { "productId": "prod_01j...", "quantity": 2 }
    ],
    "totals": {
      "subtotal": 3998,
      "total": 3998,
      "currency": "usd"
    }
  }
}

Add item

Adds a product to the cart. If the product is already in the cart, the quantity is increased by the amount you specify.

POST /cart/:cartId/lines

Path parameters

string

required

The ID of the cart to add the item to.

Body parameters

string

required

The ID of the product to add.

number

required

The number of units to add.

Request

curl -X POST https://api.quickshops.app/v1/cart/cart_01j.../lines \
  -H "Authorization: Bearer qk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "productId": "prod_01j...", "quantity": 1 }'

Response

Returns the updated cart in a data object.

{
  "data": {
    "id": "cart_01j...",
    "storeId": "store_01j...",
    "lines": [
      { "productId": "prod_01j...", "quantity": 1 }
    ],
    "totals": {
      "subtotal": 1999,
      "total": 1999,
      "currency": "usd"
    }
  }
}

Update item quantity

Sets the quantity of an existing line item. Use this to increase or decrease the quantity of a product already in the cart.

PATCH /cart/:cartId/lines/:productId

Path parameters

string

required

The ID of the cart containing the item.

string

required

The ID of the product whose quantity you want to update.

Body parameters

number

required

The new quantity for this line item.

Request

curl -X PATCH https://api.quickshops.app/v1/cart/cart_01j.../lines/prod_01j... \
  -H "Authorization: Bearer qk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "quantity": 3 }'

Response

Returns the updated cart in a data object.

Remove item

Removes a product from the cart entirely.

DELETE /cart/:cartId/lines/:productId

Path parameters

string

required

The ID of the cart containing the item.

string

required

The ID of the product to remove.

Request

curl -X DELETE https://api.quickshops.app/v1/cart/cart_01j.../lines/prod_01j... \
  -H "Authorization: Bearer qk_your_key_here"

Response

Returns the updated cart in a data object with the item removed.

Clear cart

Removes all items from the cart, resetting it to an empty state.

DELETE /cart/:cartId

Path parameters

string

required

The ID of the cart to clear.

Request

curl -X DELETE https://api.quickshops.app/v1/cart/cart_01j... \
  -H "Authorization: Bearer qk_your_key_here"

Response

Returns the cart in a data object with an empty lines array and zeroed totals.

{
  "data": {
    "id": "cart_01j...",
    "storeId": "store_01j...",
    "lines": [],
    "totals": {
      "subtotal": 0,
      "total": 0,
      "currency": "usd"
    }
  }
}

Get Started

Your Store

Products & Sales

Integrations

Developers

Cart API — Quickshops Headless REST API

Create cart

Request

Response

Get cart

Path parameters

Request

Response

Add item

Path parameters

Body parameters

Request

Response

Update item quantity

Path parameters

Body parameters

Request

Response

Remove item

Path parameters

Request

Response

Clear cart

Path parameters

Request

Response

​Create cart

​Request

​Response

​Get cart

​Path parameters

​Request

​Response

​Add item

​Path parameters

​Body parameters

​Request

​Response

​Update item quantity

​Path parameters

​Body parameters

​Request

​Response

​Remove item

​Path parameters

​Request

​Response

​Clear cart

​Path parameters

​Request

​Response

Create cart

Request

Response

Get cart

Path parameters

Request

Response

Add item

Path parameters

Body parameters

Request

Response

Update item quantity

Path parameters

Body parameters

Request

Response

Remove item

Path parameters

Request

Response

Clear cart

Path parameters

Request

Response