XOMNI: Experience Omni-Channel

Last Updated: July 20, 2016

This API returns a collection of related item IDs for the given item id.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/relatedItems?itemId={itemId}

URI Parameters

Parameter Name Description Type Conditions
itemId The unique ID of the item. Number

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

{
   "Data":[
      {
         "ItemId":252,
         "CategoryId":7
      }
   ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].ItemId Unique ID of the item. Number
Data[0..N].CategoryId Category ID of the related item. Number

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 GET operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Malformed item ID.
404 (Not Found) Related Items or given Item not found.