Asset APIs

DELDelete Assets

Delete assets based on supported filters. Although the public API is DELETE, the service internally calls the downstream delete-by-filter API using POST.

DELhttps://api.catalogix.ai/v1/assets
Delete assets by filter. Each item needs store_uuid and at least one of channel, parent_code or asset_id. When asset_id is given it alone selects the assets, and channel and parent_code are ignored. Otherwise channel and parent_code narrow the selection, and the channel must be enabled on the store. Items are processed independently, up to five at a time: a failing item, such as a store the caller cannot access, is reported in error_info and counted in failed while the others still run. A request carries at most 100 items (400 above that) and 10 MiB (413). Although the public method is DELETE, the service calls the downstream delete-by-filter API with POST.

Authorization

Authorizationstringrequiredheader
Bearer token, Bearer <token>. Create one under Tokens in your workspace.

Headers

X-Request-Idstring
Optional trace ID

Body

application/json required

An array of objects. Each item:

store_uuidstringrequired
Example: 699ec31355208b213e56059a
channelstring
Delete the assets of this channel. Must be enabled on the store unless asset_id is given.
Example: SMP
parent_codestring
Delete the assets of this parent code.
Example: SKU001
asset_idstring[]
Delete exactly these assets. When present, channel and parent_code are ignored. Must not be an empty array.

Responses

200Assets deleted. A per-item failure (e.g. a store the caller cannot access, or a downstream delete error) is reported in the response body as a failed count and error_info entries, not as a non-200 status.
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject
Fields
deleted_countinteger
Example: 2
failedinteger
Example: 0
error_infoobject[]
One entry per request item that failed, in request order.
Item fields
store_uuidstring
reasonstring
store access denied for a store the caller cannot access, the message of a channel the store has not enabled, or the error of the delete call.
Example: store access denied
400Validation error: an empty list, more than 100 items, a missing `store_uuid`, an item with none of `channel`, `parent_code` or `asset_id`, or an empty `asset_id` array
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
413A request body over 10 MiB
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
422Validation Error
detailobject[]
Item fields
locstring | integer[]requireddefault: ["body",""]
msgstringrequireddefault: "Field Required"
typestringrequireddefault: "missing"
500Internal server error
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Internal server error. Please contact support@catalogix.ai

Something missing or unclear? Write to support@streamoid.com.

esc