Skip to content

Delete a metaobject entry

DELETE
/stores/{storeRef}/metaobjects/{type}/entries/{id}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/metaobjects/example/entries/example \
--header 'x-api-key: <x-api-key>'

Deletes the entry. This cannot be undone.

Required scopes: write:metaobjects

type
required
string

The metaobject definition’s type handle.

id
required
string

The entry ID.

storeRef
required
string

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

The entry was deleted.

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