Preview a variant deletion
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1/deletion-impact';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1/deletion-impact \ --header 'x-api-key: <x-api-key>'Returns what deleting the variant would affect, without deleting anything: order lines that would lose their link, cart lines left pointing at a missing variant, and stock-history rows that would be removed. The counts can change before you delete. Requires the write scope because it reveals order and cart activity.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The variant ID.
The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
Order lines that would lose their link to the variant.
Cart lines that would point at a variant that no longer exists.
Stock-adjustment history rows that would be permanently deleted.
Example generated
{ "orders_affected": 1, "carts_affected": 1, "inventory_history_entries": 1}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"}