XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API can be used to fetch a list of brands having a particular tag. Brands are used by catalog APIs to filter catalog items.

Request

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

URI Parameters

Parameter Name Description Type Conditions
tagId The unique ID of a tag. Number
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
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

{
    "Data": {
        "Results": [
            {
                "Id": 1,
                "Name": "Brand 1"
            },
            {
                "Id": 2,
                "Name": "Brand 2"
            },
            {
                "Id": 3,
                "Name": "Brand 3"
            }
        ],
        "TotalCount": 5
    }
} 

Response Body Description

Parameter Name Description Type
Data.TotalCount Total count of items in the filtered collection without paging. Number
Data.Results[0..N].Id The unique ID of the brand. Number
Data.Results[0..N].Name The name of the brand. String

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 or there are no tag found for the given tag ID.
404 (Not Found) There are no brands found for the given tag.