Skip to content

Delete a variant

DELETE
/stores/{storeRef}/products/{productId}/variants/{variantId}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1 \
--header 'x-api-key: <x-api-key>'

Permanently deletes the variant and its stock history. The deletion is refused when it is the product’s last variant. The response reports how many order lines, cart lines and stock-history rows were affected; none of them blocks the deletion.

Required scopes: write:products

productId
required
integer

The product ID.

variantId
required
integer

The variant ID.

storeRef
required
string

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

Media typeapplication/json
object
deleted
required

Always true.

number
orders_affected
required

Order lines that would lose their link to the variant.

number
carts_affected
required

Cart lines that would point at a variant that no longer exists.

number
inventory_history_entries
required

Stock-adjustment history rows that would be permanently deleted.

number

Example

{
"deleted": true
}

The request is malformed or failed validation.

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