XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API enables a client application to find the exact list of items required by allowing a rich and flexible search backend. The search request parameters has multiple fields and options available that can be used separately or combined.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/items/search?categoryId={categoryId}&brandId={brandId}&defaultItemId={defaultItemId}&SKU={SKU}&UUID={UUID}&itemIds={itemIds}&includeOnlyMasterItems={includeOnlyMasterItems}&skip={skip}&take={take}&dynamicAttributeTypeId={dynamicAttributeTypeId}&dynamicAttributeTypeValueId={dynamicAttributeTypeValueId}

URI Parameters

Parameter Name Description Type Conditions
brandId Unique ID of the brand, Number
categoryId Unique ID of the category. Number
defaultItemId The unique ID of the default item in the set of variant items. Number
SKU SKU of the item. String
itemIds Comma seperated item ID list. Example:1,2,3,4,5 String
UUID UUID of the item. String
includeOnlyMasterItems A Boolean field indicating whether 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
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
dynamicAttributeTypeId Unique ID of the dynamic attribute type. Number
dynamicAttributeTypeValueId Unique ID of the dynamic attribute type value. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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":[
      {
         "CategoryName":"03d5f407-a10e-4ae8-b135-9b4100e33bed",
         "BrandName":"f5ef79d4-0697-401a-8a81-814c53d6ccb5",
         "HasVariants":true,
         "DefaultImage":{
            "ResizedAssets":[

            ],
            "Resizeable":false,
            "IsDefault":true,
            "ContentMimeType":"image/jpeg",
            "OriginalFilename":"6345d616-7a7b-4962-bba4-c59da43d2ae4",
            "AssetId":7,
            "AssetUrl":"http://127.0.0.1:10000/images/c0be821e-baeb-4e20-9ebe-375fa465943e"
         },
         "DefaultVideo":{
            "IsDefault":true,
            "ContentMimeType":"image/jpeg",
            "OriginalFilename":"4792bd0c-7f2e-421c-b34d-9fbff6f330a4",
            "AssetId":8,
            "AssetUrl":"http://127.0.0.1:10000/videos/86540ea1-0f96-445b-94ea-3d003e9947df"
         },
         "DefaultDocument":{
            "IsDefault":true,
            "ContentMimeType":"image/jpeg",
            "OriginalFilename":"fe164271-757e-44bf-89ca-d41b34770ec6",
            "AssetId":9,
            "AssetUrl":"http://127.0.0.1:10000/documents/5a993823-0bed-4459-9f97-7159f8c206c3"
         },
         "Id":24,
         "RFID":"a13ff527-be2a-42c2-b0fa-b2bdf3b3e208",
         "UUID":"66648dda-c2c8-4bee-b984-3eb9a1a5ee7b",
         "SKU":"22186",
         "Name":"61e9741a-58c8-4ac9-b8b4-0a1def382bfb",
         "Model":"a9a6dd6f-7f00-4056-ba3a-823ee9433a7c",
         "Title":"1bf78ecc-712b-4e1f-a1ab-f0364c75e81f",
         "ShortDescription":"d10b4849-f0d5-41e3-948c-f339bc5a4af5",
         "LongDescription":"67fa7385-1eed-4c2c-ab14-a4e3dbcbbeef",
         "Rating":1.0,
         "LikeCount":22,
         "DateAdded":"2014-09-26T02:26:21.34",
         "DateModified":"2014-09-26T02:26:21.34",
         "ItemStatusId":1,
         "CategoryId":72,
         "InStock":true,
         "PublicWebLink":"f3e29381-c9da-4ba1-84ee-2ddf84ad28f3",
         "DefaultItemId":null,
         "BrandId":9,
         "UnitTypeId":null,
         "DynamicAttributes":[

         ],
         "Prices":[

         ],
         "Tags":[

         ],
         "Weights":[

         ],
         "Dimensions":[

         ]
      }
   ],
   "TotalCount":1
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of items in the filtered collection without paging. Number
Results[0..N].CategoryName The name of a category assigned to the item. String
Results[0..N].BrandName The name of a brand assigned to the item. String
Results[0..N].HasVariants The Boolean field indicating if the item has variants or doesn’t. Unknown
Results[0..N].Id Unique ID of the item. Number
Results[0..N].RFID RFID of the item. String
Results[0..N].UUID UUID of the item. String
Results[0..N].SKU SKU of the item. String
Results[0..N].Name Name of the item. String
Results[0..N].Model Model of the item. String
Results[0..N].Title Title of the item. String
Results[0..N].ShortDescription Short description of the item. String
Results[0..N].LongDescription Long description of the item. String
Results[0..N].Rating Rating of the item. Number
Results[0..N].LikeCount Like count of the item. Number
Results[0..N].DateAdded Item creation date. Date
Results[0..N].DateModified Item last modification date. Date
Results[0..N].ItemStatusId Status ID of the item. Number
Results[0..N].CategoryId The unique Id of a category assigned to the item. Number
Results[0..N].InStock The boolean field indicating if the item is in stock or not. Unknown
Results[0..N].PublicWebLink Public web link of the item String
Results[0..N].DefaultItemId The Id of the default item in the associated variant list. If the DefaultItemID is equal to the Id the current item is a default item in its variant list. Number
Results[0..N].BrandId The unique Id of a brand assigned to the item. Number
Results[0..N].UnitTypeId ID of item’s unit type Number
Results[0..N].Tags[0..N].Id The unique ID of the tag. Number
Results[0..N].Tags[0..N].Name Name of the tag. String
Results[0..N].Tags[0..N].Description Description of the tag. String
Results[0..N].Tags[0..N].TagMetadata[0..N].Key Key of the metadata. String
Results[0..N].Tags[0..N].TagMetadata[0..N].Value Value of the metadata. String
Results[0..N].Prices[0..N].PriceId Unique ID of the price. Number
Results[0..N].Prices[0..N].ItemId Unique ID of the item. Number
Results[0..N].Prices[0..N].NormalPrice Regular price of the item. Number
Results[0..N].Prices[0..N].DiscountPrice Discount price of the item. Number
Results[0..N].Prices[0..N].PriceTypeSymbol The code of the price type used to define the price. String
Results[0..N].Prices[0..N].PriceTypeId The unique ID of the price type used to define the price. Number
Results[0..N].DynamicAttributes[0..N].TypeId Unique ID of a dynamic field. Number
Results[0..N].DynamicAttributes[0..N].TypeValueId Unique ID of a dynamic field value. Number
Results[0..N].DynamicAttributes[0..N].Value Value of a dynamic field. String
Results[0..N].DynamicAttributes[0..N].TypeName Unique name of a dynamic field. String
Results[0..N].DefaultDocument.IsDefault Boolean field indicating whether this asset is the default document or video of the related object or not. Unknown
Results[0..N].DefaultDocument.ContentMimeType Content mime-type of the asset. String
Results[0..N].DefaultDocument.OriginalFilename Original file name of the asset. String
Results[0..N].DefaultDocument.AssetId Unique ID of the asset. Number
Results[0..N].DefaultDocument.AssetUrl The unique URL of the asset. String
Results[0..N].DefaultVideo.IsDefault Boolean field indicating whether this asset is the default document or video of the related object or not. Unknown
Results[0..N].DefaultVideo.ContentMimeType Content mime-type of the asset. String
Results[0..N].DefaultVideo.OriginalFilename Original file name of the asset. String
Results[0..N].DefaultVideo.AssetId Unique ID of the asset. Number
Results[0..N].DefaultVideo.AssetUrl The unique URL of the asset. String
Results[0..N].DefaultImage.Resizeable Boolean field indicating whether this image is resizeable or not. Unknown
Results[0..N].DefaultImage.IsDefault Boolean field indicating whether this asset is the default image of the related object or not. Unknown
Results[0..N].DefaultImage.ContentMimeType Content mime type of the image. String
Results[0..N].DefaultImage.OriginalFilename Original file name of the asset. String
Results[0..N].DefaultImage.AssetId Unique ID of the asset. Number
Results[0..N].DefaultImage.AssetUrl The unique URL of the asset. String
Results[0..N].DefaultImage.ResizedAssets[0..N].CreatedDate Creation date of the resized asset. Date
Results[0..N].DefaultImage.ResizedAssets[0..N].AssetUrl The unique URL of the asset. String
Results[0..N].DefaultImage.ResizedAssets[0..N].ImageSizeProfile.Id The unique ID of the resized asset size profile. Number
Results[0..N].DefaultImage.ResizedAssets[0..N].ImageSizeProfile.Height Height of the resized asset. Number
Results[0..N].DefaultImage.ResizedAssets[0..N].ImageSizeProfile.Width Width of the resized asset. 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.