Product APIs

DELDelete Product

Delete product data

DELhttps://api.catalogix.ai/v1/products
Deletes products by SKU. Send at most 100 sku_codes; a blank or repeated code fails with 422. Deleted products are archived. A code that matches no product is not an error: it is listed in failed_codes and nothing is done for it. A downstream failure is returned with HTTP 200 and status.code -1.

Authorization

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

Query parameters

store_uuidstringrequired
Example: 67762d4ce590324df813bd8c
sku_codesstring[]required
SKU codes (product_code) of the products to delete, at most 100. Any code that exists in the store can be deleted.

Headers

X-Request-Idstring
Optional trace ID. If not provided, one is generated automatically

Responses

200Request processed. status.code 0 means the downstream delete succeeded; failed_codes is then empty, or lists the codes that matched no product. A downstream failure is reported with status.code -1 and message "An error occurred" or "Invalid JSON response", with an empty failed_codes, not as a non-200 status.
statusobjectrequired
Status of the operation, including code and message
Fields
codeintegerrequired
Status code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example: 0
messagestringrequired
Message describing the status
Example: success
request_idstring
Unique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
failed_codesobject
Empty when every code was found and deleted. Otherwise lists the codes that matched no product; nothing is done for those.
Fields
messagestring
Example: some product_codes not found in the system; no action taken for these
product_codesstring[]
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
413More than 100 sku_codes
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
422Validation error: a missing store_uuid or sku_codes, or a blank or repeated sku_code
detailobject[]
Item fields
locstring | integer[]requireddefault: ["body",""]
msgstringrequireddefault: "Field Required"
typestringrequireddefault: "missing"

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

esc