Skip to content

Delete a metafield definition

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

Deletes the definition and every value stored under it. This cannot be undone; read value_count first to see how many values will go.

Required scopes: write:metafields

id
required
string

The metafield definition ID.

storeRef
required
string

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

The definition and its values were 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"
}