XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The tag management systems provides APIs to fetch a full list of item tag relations from the backend. Tags are used by catalog APIs to filter catalog items.

Request

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

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. 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

{
    "Results":[
       {
           "ItemId":1,
           "TagId":84
       },
       {
           "ItemId":2,
           "TagId":84
       },
       {
           "ItemId":3,
           "TagId":84
       },
       {
           "ItemId":4,
           "TagId":84
       },
       {
           "ItemId":5,
           "TagId":84
       }
    ],
    "TotalCount":5
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of the items in filtered collection without paging. Number
Results[0..N].ItemId The unique ID of an item Number
Results[0..N].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
400 (Bad Request) Skip and/or take parameters are malformed.
404 (Not Found) No item tag relation found in backend.