XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API is designed to provide asset delete APIs. Using this API, you can delete an asset from storage.

Request

HTTP Method Resource URI
DELETE https://{tenantName}.api.xomni.com/private/storage/assets/{assetId}?force={force}

URI Parameters

Parameter Name Description Type Conditions
assetId The unique ID of the asset. Do not send resized asset ID. Sending resized asset id could cause some unexpected asset deletion. Number
force A Boolean field indicating whether the API deletes asset in spite of their relations. Boolean

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

The response does not contain any response entity if the status is successful.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 202 (Accepted) for DELETE operations. Possible response status codes are as listed below:

Status Code Description
202 (Accepted) Asset delete operation successfully completed.
404 (Not Found) Asset not found.
409 (Conflict) Asset has relations with item, brand or category. (This status code occurs if you send force flag as false)
500 (Internal Server Error) An error occured while deleting asset.