XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch a full list of items from the backend.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/items?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
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

{
    "Results":[
       {           
	 "Id":1,
           "RFID":null,
           "UUID":null,
           "SKU":null,
           "Name":"D1 Red-S-A Style",
           "Model":"Model 1",
           "Title":"D1 Title",
           "ShortDescription":"Master Item 1 Short Description",
           "LongDescription":null,
           "Rating":null,
           "LikeCount":80,
           "CategoryId":66,
           "InStock":true,
           "PublicWebLink":null,
           "DefaultItemId":null,
           "BrandId":1,
           "UnitTypeId":3,
           "DynamicAttributes":[
              {
                  "TypeId":1,
                  "TypeValueId":1,
                  "Value":"Red",
                  "TypeName":"Color"
              },
              {
                  "TypeId":3,
                  "TypeValueId":7,
                  "Value":"A",
                  "TypeName":"Style"
              },
              {
                  "TypeId":2,
                  "TypeValueId":9,
                  "Value":"S",
                  "TypeName":"Size"
              }
           ],
           "Prices":[
              {
                  "PriceId":1,
                  "ItemId":1,
                  "NormalPrice":140.55,
                  "DiscountPrice":null,
                  "CurrencySymbol":"$",
                  "CurrencyId":1
              },
              {
                  "PriceId":2,
                  "ItemId":1,
                  "NormalPrice":100.55,
                  "DiscountPrice":null,
                  "CurrencySymbol":"€",
                  "CurrencyId":2
              }
           ],
           "Tags":[
              {
                  "Id":1,
                  "Name":"Sample Tag 0",
                  "Description":"693aaa60-8dad-4236-96d1-99f3ca0f175a",
                  "TagMetadata":[
                     {
                         "Key":"Key0",
                         "Value":"165b851b-49e9-4798-a55c-1362e299a47c",
                     },
                     {
                         "Key":"Key0",
                         "Value":"396def9c-c6bb-4dff-84de-953551a179e5",
                     },
                     {
                         "Key":"Key0",
                         "Value":"08ef14a2-0ac0-4f99-a83e-e54f24910f73",
                     },
                     {
                         "Key":"Key0",
                         "Value":"7ba700cf-8f91-4324-bc0d-5f7724555bba",
                     },
                     {
                         "Key":"Key0",
                         "Value":"380e1d89-17bf-44b1-b800-364f53cb1d92",
                     }
                  ]
              },
              {
                  "Id":2,
                  "Name":"Sample Tag 1",
                  "Description":"fbf64b85-215e-4ce1-a3c4-b8f8bca23c91",
                  "TagMetadata":[
                     {
                         "Key":"Key1",
                         "Value":"73a2e38b-e546-464f-8e17-ad39db22d366",
                     },
                     {
                         "Key":"Key1",
                         "Value":"ec1bb106-786e-4526-837e-940e47c1ac74",
                     },
                     {
                         “Key":"Key1",
                         "Value":"71f184cf-17db-4219-8a73-bcbf860a76ed",
                     },
                     {
                         "Key":"Key1",
                         "Value":"a8253e08-de6e-4cf1-9a4e-1769575048ae",
                     },
                     {
                         "Key":"Key1",
                         "Value":"7a5c45c0-bbb1-49fa-863a-e08161b0333b",
                     }
                  ]
              }
           ],
           "Weights":[
              {
                  "WeightId":7,
                  "WeightTypeId":1,
                  "WeightTypeDescription":"Kg",
                  "Value":3.0
              },
              {
                  "WeightId":8,
                  "WeightTypeId":2,
                  "WeightTypeDescription":"LBS",
                  "Value":5.0
              }
           ],
           "Dimensions":[
              {
                  "DimensionId":1,
                  "DimensionTypeId":1,
                  "DimensionDescription":"Meter",
                  "Width":1.0,
                  "Height":1.0,
                  "Depth":1.0
              },
              {
                  "DimensionId":2,
                  "DimensionTypeId":2,
                  "DimensionDescription":"Inch",
                  "Width":3.0,
                  "Height":3.0,
                  "Depth":3.0
              }
           ]
       },
       {
           "Id":2,
           "RFID":null,
           "UUID":null,
           "SKU":null,
           "Name":"D2 Red-S-A Style",
           "Model":"Model 2",
           "Title":"D2 Title",
           "ShortDescription":"D2 Short Description",
           "LongDescription":"D2 Long Description",
           "Rating":null,
           "LikeCount":null,
           "CategoryId":67,
           "InStock":true,
           "PublicWebLink":null,
           "DefaultItemId":null,
           "BrandId":2,
           "UnitTypeId":2,
           "DynamicAttributes":[
              {
                  "TypeId":1,
                  "TypeValueId":1,
                  "Value":"Red",
                  "TypeName":"Color"
              },
              {
                  "TypeId":3,
                  "TypeValueId":7,
                  "Value":"A",
                  "TypeName":"Style"
              },
              {
                  "TypeId":2,
                  "TypeValueId":9,
                  "Value":"S",
                  "TypeName":"Size"
              }
           ],
           "Prices":[
              {
                  "PriceId":3,
                  "ItemId":2,
                  "NormalPrice":10.55,
                  "DiscountPrice":null,
                  "CurrencySymbol":"$",
                  "CurrencyId":1
              },
              {
                  "PriceId":4,
                  "ItemId":2,
                  "NormalPrice":20.55,
                  "DiscountPrice":15.0,
                  "CurrencySymbol":"€",
                  "CurrencyId":2
              }
           ],
           "Tags":[
              {
                  "Id":1,
                  "Name":"Sample Tag 0",
                  "Description":"693aaa60-8dad-4236-96d1-99f3ca0f175a",
                  "TagMetadata":[
                     {
                         "Key":"Key0",
                         "Value":"165b851b-49e9-4798-a55c-1362e299a47c",
                     },
                     {
                         "Key":"Key0",
                         "Value":"396def9c-c6bb-4dff-84de-953551a179e5",
                     },
                     {
                         "Key":"Key0",
                         "Value":"08ef14a2-0ac0-4f99-a83e-e54f24910f73",
                     },
                     {
                         "Key":"Key0",
                         "Value":"7ba700cf-8f91-4324-bc0d-5f7724555bba",
                     },
                     {
                         "Key":"Key0",
                         "Value":"380e1d89-17bf-44b1-b800-364f53cb1d92",
                     }
                  ]
              },
              {
                  "Id":2,
                  "Name":"Sample Tag 1",
                  "Description":"fbf64b85-215e-4ce1-a3c4-b8f8bca23c91",
                  "TagMetadata":[
                     {
                         "Key":"Key1",
                         "Value":"73a2e38b-e546-464f-8e17-ad39db22d366",
                     },
                     {
                         "Key":"Key1",
                         "Value":"ec1bb106-786e-4526-837e-940e47c1ac74",
                     },
                     {
                         "Key":"Key1",
                         "Value":"71f184cf-17db-4219-8a73-bcbf860a76ed",
                     },
                     {
                         "Key":"Key1",
                         "Value":"a8253e08-de6e-4cf1-9a4e-1769575048ae",
                     },
                     {
                         "Key":"Key1",
                         "Value":"7a5c45c0-bbb1-49fa-863a-e08161b0333b",
                     }
                  ]
              }
           ],
           "Weights":[
              {
                  "WeightId":9,
                  "WeightTypeId":1,
                  "WeightTypeDescription":"Kg",
                  "Value":8.0
              },
              {
                  "WeightId":10,
                  "WeightTypeId":2,
                  "WeightTypeDescription":"LBS",
                  "Value":11.0
              }
           ],
           "Dimensions":[
              {
                  "DimensionId":3,
                  "DimensionTypeId":1,
                  "DimensionDescription":"Meter",
                  "Width":11.0,
                  "Height":11.0,
                  "Depth":11.0
              },
              {
                  "DimensionId":4,
                  "DimensionTypeId":2,
                  "DimensionDescription":"Inch",
                  "Width":5.0,
                  "Height":5.0,
                  "Depth":5.0
              }
           ]
       }
    ],
    "TotalCount":23
}

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 item Number
Results[0..N].RFID The radio frequency id of the item String
Results[0..N].UUID The universally unique ID of the item String
Results[0..N].SKU Stock keeping unit 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 added 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].Dimensions[0..N].DimensionId The unique ID of the dimension. Number
Results[0..N].Dimensions[0..N].DimensionTypeId The unique ID of the dimension type to define the dimension. Number
Results[0..N].Dimensions[0..N].DimensionDescription The description of the dimension type to define the dimension. String
Results[0..N].Dimensions[0..N].Width The width value of the item. Number
Results[0..N].Dimensions[0..N].Height The hight value of the item. Number
Results[0..N].Dimensions[0..N].Depth The depth value of the item. Number
Results[0..N].Weights[0..N].WeightId The unique ID of the weight. Number
Results[0..N].Weights[0..N].WeightTypeId The unique ID of the weight type to define the weight. Number
Results[0..N].Weights[0..N].WeightTypeDescription The description of the weight type used to define the weight. String
Results[0..N].Weights[0..N].Value The weight value of the item. Number
Results[0..N].Tags[0..N].Id The unique ID of the tag. Number
Results[0..N].Tags[0..N].Name The name of the tag. String
Results[0..N].Tags[0..N].Description The description of the tag. String
Results[0..N].Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Results[0..N].Tags[0..N].TagMetadata[0..N].Value The 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 The regular price of the item. Number
Results[0..N].Prices[0..N].DiscountPrice The discounted 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

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.