Skip to content

Empty a guest cart

DELETE
/public/stores/{storeRef}/cart
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/public/stores/example/cart \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Removes every line from the guest cart. The cart itself is kept. The request fails with a server error when no cart exists for the session.

storeRef
required
string

The store’s ref, as returned by GET /stores.

x-session-id
string

An ID that identifies the visitor’s guest cart. Generate a random value (a UUID works) the first time, keep it in the browser and send it on every guest cart request. Without it, requests are not tied to a cart.

Media typeapplication/json
object
cart_id
required

ID of the cart that was emptied.

string

Example generated

{
"cart_id": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}