XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API filters brands by the properties of the items associated with it. The below query will help you query all items in the catalogue and fetch the distinct list of brands used by the resulting catalogue item list.

Request

{
    "DefaultItemId":null,
    "RFID":null,
    "UUID":null,
    "Name":null,
    "SKU":null,
    "CategoryId":66,
    "BrandId":12,
    "Model":null,
    "Title":null,
    "MinWidth":100,
    "MaxWidth":300,
    "MinHeight":null,
    "MaxHeight":null,
    "MinWeigth":null,
    "MaxWeigth":null,
    "MinDepth" : null,
    "MaxDepth" : null,
    "DimensionTypeId" : 2,
    "WeightTypeId" :null,
    "MinPrice":null,
    "MaxPrice":null,
    "TagId":6,
    "DelimitedDynamicAttributeValues":null,
    "IncludeOnlyMasterItems":false,
    "TagQuery" : null,
    "IncludePassiveItems" : false
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/catalog/brands

Request Body Description

Parameter Name Description Type Conditions
DefaultItemId The unique ID of the default item in the variant list associated to the current item. Number
RFID The radio frequency ID of the item. String
UUID The universally unique ID of the item. String
Name The name of the item. String
SKU Stock keeping unit of the item. String
CategoryId The unique Id of a category assigned to the item. Number
BrandId The unique Id of a brand assigned to the item. Number
Model The model of the item. String
Title The title of the item. String
MinWidth Minimum width criteria. Number
MaxWidth Maximum width criteria. Number
MinHeight Minimum height criteria. Number
MaxHeight Maximum height criteria. Number
MinWeight Minimum weight criteria. Number
MaxWeight Maximum weight criteria. Number
MinDepth Minimum depth criteria. Number
MaxDepth Maximum depth criteria. Number
MinPrice Minimum price criteria. Number
MaxPrice Maximum price criteria. Number
DimensionTypeId Dimension type ID of minimum and maximum weight, height, depth criteria. Number
WeightTypeId Weight type ID of minimum and maximum weight criteria. Number
TagId A particular tag of an item. Number
DelimitedDynamicAttributeValues A list of dynamic fields to query. The query should have a list of TypeID and TypeValueID pairs or TypeID and Value pairs. String
IncludeOnlyMasterItems A Boolean field indicating if the search operation should only cover master items or not. If the field value is “false”, the result set will contain variant items as well. Boolean
TagQuery A string field that filters on tags like a where clause query (e.g: "(TagIds: 1 OR 2 OR 3)"). String
IncludePassiveItems A Boolean field indicating if the search operation should cover passive items or not. If the field value is “false”, the result set will contain active items as well. Boolean

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
PriceTypeId
Default price type ID when performing price based filtering and sorting.
Sample: MQ==
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": [
        {
            "Id": 1,
            "Name": "Sample Brand 0"
        },
        {
            "Id": 2,
            "Name": "Sample Brand 1"
        },
        {
            "Id": 3,
            "Name": "Sample Brand 2"
        }
    ]
} 

Response Body Description

Parameter Name Description Type
Data[0..N].Id The unique ID of the brand. Number
Data[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 POST operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) There are no brands found for the specified search filters.