Skip to content

Purge a store's cache

POST
/stores/{storeRef}/purge-cache
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/purge-cache \
--header 'x-api-key: <x-api-key>'

Clears every cached copy of the store’s data, including domain lookups and public data, so the next request reads fresh data. Use it after changes made outside the API. The first requests afterwards are slower while caches refill.

Required scopes: write:settings

storeRef
required
string

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

Media typeapplication/json
object
success
required

Always true when the call succeeds.

boolean
message
required

A short confirmation text.

string

Example generated

{
"success": true,
"message": "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"
}

The resource does not exist in this store.

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"
}