Delete several assets
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/assets';const options = { method: 'DELETE', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"asset_ids":["uuid-1","uuid-2","uuid-3"]}'};
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/assets \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "asset_ids": [ "uuid-1", "uuid-2", "uuid-3" ] }'Deletes the listed assets in one request. Assets that are still in use, unknown or in another store are skipped and returned in failedAssets with the reason; the rest are deleted. The request is answered with 200 even when some assets fail.
Required scopes: write:assets
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Array of asset IDs to delete
Example
[ "uuid-1", "uuid-2", "uuid-3"]Responses
Section titled “Responses”object
The assets that were not deleted, each with the reason.
object
ASSET_IN_USE when the asset was refused because something still shows it.
Where the asset is still used. Present with ASSET_IN_USE.
object
Kind of record using the asset, such as product or blog_post.
Name of the record using the asset, when it has one.
ID of the record using the asset.
Total number of places that use the asset. Present with ASSET_IN_USE.
ID of the asset.
Why the asset was not deleted.
Number of assets that were deleted.
A readable summary such as Deleted 2 of 3 assets.
Example
{ "failedAssets": [ { "usages": [ { "type": "product" } ] } ]}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"}