XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The Related Items API returns a collection of related item ids for a given item id.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/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
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

[
   {
      "CategoryId":1,
      "ItemId":12
   },
   {
      "CategoryId":4,
      "ItemId":15
   },
   {
      "CategoryId":null,
      "ItemId":19
   }
]

Response Body Description

Parameter Name Description Type
Item.ItemId Unique ID of the item. Number
Item.CategoryId Category ID of the 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.