Asset APIs

POSTUnlink Assets

Unlink one or more assets from a given `parent_code` and `channel`.

POSThttps://api.catalogix.ai/v1/assets/unlink
Unlink assets from a parent_code and channel. The asset itself is kept, only its link to that product and channel is removed. Every item needs store_uuid, parent_code, channel and asset_id, and the channel must be enabled on the store. Items are handled independently: an item for a store the caller cannot access, or for a channel the store has not enabled, is reported in error_info and counted in failed while the others are still unlinked. A request carries at most 100 items and 10 MiB, otherwise it fails with 413.

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
parent_codestringrequired
Parent code the asset is linked to. It cannot be blank.
Example: SKU001
channelstringrequired
Channel the link belongs to. It must be enabled on the store.
Example: SMP
asset_idstringrequired
Identifier of the asset to unlink, as returned by the assets listing. It cannot be blank.

Responses

200Assets unlinked
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject
Fields
unlinkedinteger
Example: 2
failedinteger
Example: 0
error_infoobject[]
One entry per item that was not unlinked.
Item fields
asset_idstring
parent_codestring
Example: SKU001
reasonstring
store access denied for a store the caller cannot access, the message of a channel the store has not enabled (for example Ontology 'X' not found in store channels), or the status the assets service gave the item (not_found when it gave none).
Example: not_found
400Validation error
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
413More than 100 items in the request, or a request body over 10 MiB
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
422Validation error: a malformed body, a blank `parent_code`, `channel` or `asset_id`, or the same asset unlinked twice for one store, `parent_code` and channel
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
502Downstream service unavailable
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error

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

esc