Skip to content

Delete an attribute

DELETE
/stores/{storeRef}/attributes/{attributeId}
curl --request DELETE \
--url 'https://apibase.ecomweb.app/api/v1/stores/example/attributes/1?force=true' \
--header 'x-api-key: <x-api-key>'

Permanently deletes the attribute and its values. An attribute that product variants use cannot be deleted and is refused with a 409 error. An attribute still attached to products is also refused with 409 unless you send force=true, which detaches it from those products first. The response has an empty body.

Required scopes: write:products

attributeId
required
integer

The attribute ID.

storeRef
required
string

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

force
string
Allowed values: true false

Send true to delete the attribute even if products still use it. Variant usage still blocks the delete.

The attribute was deleted.

Media typeapplication/json

The response body is empty.

string
0

Example generated

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

The request conflicts with the resource’s current state.

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