XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The brand management systems provide APIs to fetch a full list of brands. Brands are used by catalog APIs to filter catalog items.


HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/brands?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
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da


    "Data": {
        "Results": [
                "Id": 1,
                "Name": "Brand 1"
                "Id": 2,
                "Name": "Brand 2"
                "Id": 3,
                "Name": "Brand 3"
        "TotalCount": 12

Response Body Description

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

Response Headers

Header Field Name Description
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) There are no brands defined in the backend.