XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The tag management systems provides APIs to fetch related items of a particular tag from backend. Using this API, you can get related items of a particular tag.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/itemtagmapping?tagId={tagId}

URI Parameters

Parameter Name Description Type Conditions
tagId The unique ID of a tag. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

[
   {
       "ItemId": 1,
       "TagId": 29
   },
   {
       "ItemId": 2,
       "TagId": 29
   },
   {
       "ItemId": 3,
       "TagId": 29
   },
   {
       "ItemId": 4,
       "TagId": 29
   },
   {
       "ItemId": 5,
       "TagId": 29
   }
]

Response Body Description

Parameter Name Description Type
Item.ItemId The unique ID of an item Number
Item.TagId The unique ID of a tag. 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
404 (Not Found) The given tag or the related item for the given tag could not be found.