Delete a product
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1';const options = { method: 'DELETE', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"soft_delete":true,"reason":"Entity deletion requested by user","force":false,"delete_variants":true,"check_orders":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://apibase.ecomweb.app/api/v1/stores/example/products/1 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "soft_delete": true, "reason": "Entity deletion requested by user", "force": false, "delete_variants": true, "check_orders": true }'Soft-deletes the product by default: it disappears from the store and its slug is freed, but the record is kept. Send force: true to delete it permanently, which cannot be undone. delete_variants (default true) also removes or deactivates the product’s variants.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Whether to perform soft delete (disable) or hard delete (remove)
Example
trueReason for deletion (for audit purposes)
Example
Entity deletion requested by userForce delete even if entity has active dependencies
Example
falseWhether to also delete all product variants
Example
trueWhether to check for active orders before deletion
Example
trueResponses
Section titled “Responses”object
soft keeps the product recoverable by staff; hard removes it permanently.
Whether the deletion succeeded.
A readable result message.
ID of the deleted product.
Number of variants removed or deactivated.
When the product was soft-deleted, as an ISO 8601 timestamp. Absent for a hard delete.
Example
{ "type": "soft"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}