XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API can be used to update relationships between assets and categories. Using this API, you can change default document of the category.

Request

{
    "AssetId":12,
    "IsDefault":"true"
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/catalog/categories/{categoryId}/document

URI Parameters

Parameter Name Description Type Conditions
categoryId Unique ID of category. Number

Request Body Description

Parameter Name Description Type Conditions
AssetId The unique ID of the created asset. Number
IsDefault Boolean field indicating if this asset is the default asset of the relationship member or not. Boolean

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "AssetId":12,
    "IsDefault":"true",
    "RelatedId":1
}

Response Body Description

Parameter Name Description Type
AssetId The unique ID of the created asset. Number
RelatedId The unique ID of the relationship member. Brand ID, Category ID or Item ID. Number
IsDefault Boolean field indicating if this asset is the default asset of the relationship member or not. Boolean

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 200 (OK) for PUT operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Asset not found.
404 (Not Found) Asset&category relation not found.