Empty a guest cart
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/cart';const options = {method: 'DELETE', headers: {'x-storefront-api-key': '<x-storefront-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Header Parameters
Section titled “Header Parameters”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.
Responses
Section titled “Responses”object
ID of the cart that was emptied.
Example generated
{ "cart_id": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}