XOMNI: Experience Omni-Channel

Last Updated: August 26, 2016

This API allows a client application to fetch a single item by its unique ID. This item information is used by client applications to display item details.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/item/{id}?includeItemStaticProperties={includeItemStaticProperties}&includeItemDynamicProperties={includeItemDynamicProperties}&imageAssetDetail={imageAssetDetail}&videoAssetDetail={videoAssetDetail}&documentAssetDetail={documentAssetDetail}&includeItemInStoreMetadata={includeItemInStoreMetadata}

URI Parameters

Parameter Name Description Type Conditions
id The ID of the Item. Number
includeItemStaticProperties A Boolean filed indicating whether the response contains items static properties (like SKU, RFID, CategoryId etc. except for Dynamic Attributes). Boolean
includeItemDynamicProperties A boolean filed indicating if the response contains items dynamic properties (like DynamicAttributes). Boolean
imageAssetDetail An integer field indicating whether the response contains item image assets (see Possible values for ImageAssetDetail below). Number
videoAssetDetail An integer field indicating whether the response contains item image assets (see Possible values for VideoAssetDetail below). Number
documentAssetDetail An integer field indicating whether the response contains item image assets (see Possible values for DocumentAssetDetail below). Number
IncludeItemInStoreMetadata Indicates if the result set should contain item store metadata or not. Boolean

Possible Values For ImageAssetDetail

Value Description
0 Default Value – Image assets are not included in response.
1 Includes only default image asset.
2 Includes only default image asset with metadata.
4 Includes all image assets.
8 Includes all image assets with metadata.

Possible Values For VideoAssetDetail

Value Description
0 Default Value – Video assets are not included in response.
1 Includes only default image asset.
2 Includes only default video asset with metadata.
4 Includes all video assets.
8 Includes all video assets with metadata.

Possible Values For DocumentAssetDetail

Value Description
0 Default Value – Document assets are not included in response.
1 Includes only default document asset.
2 Includes only default document asset with metadata.
4 Includes all document assets.
8 Includes all document assets with metadata.

Request Headers

Header Field Name Description
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": {
        "Item": {
            "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"
                }
            ],
            "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": 1,
            "BrandId": 1,
            "UnitTypeId": 3,
            "UnitTypeName": "Quantity",
            "UnitTypeCode": "Quantity",
            "Prices": [
                {
                    "NormalPrice": 140.55,
                    "DiscountPrice": null,
                    "PriceTypeSymbol": "$",
                    "PriceTypeId": 1
                }
            ],
            "Tags": [
                {
                    "Id": 2,
                    "Name": "Sample Tag 1",
                    "Description": "3e129d70-2308-4dc5-bd33-c389b92859d2"
                }
            ],
            "Weights": [
                {
                    "WeightTypeId": 1,
                    "WeightTypeDescription": "Kg",
                    "Value": 20
                },
                {
                    "WeightTypeId": 2,
                    "WeightTypeDescription": "LBS",
                    "Value": 40
                }
            ],
            "Dimensions": [
                {
                    "DimensionTypeId": 1,
                    "DimensionDescription": "Meter",
                    "Width": 1,
                    "Height": 1,
                    "Depth": 1
                },
                {
                    "DimensionTypeId": 2,
                    "DimensionDescription": "Inch",
                    "Width": 3,
                    "Height": 3,
                    "Depth": 3
                }
            ],
            "Metadata": [
                {
                    "Key": "Key1",
                    "Value": "291b4f13-0881-4228-92f4-7bcef85a7fc0"
                }
            ],
            "InStoreMetadata": [
                {
                    "Key": "Key1",
                    "Value": "291b4f13-0881-4228-92f4-7bcef85a7fc0"
                }
            ],
            "ImageAssets": [
                {
"ResizedAssets":[
   {
       "ImageSizeProfile":{
           "Id":1,
           "Height":300,
           "Width":500
       },
       "AssetUrl":"6D16EE1F-73A1-4BB0-9BAA-8FD27C0B3568"
   },
   {
       "ImageSizeProfile":{
           "Id":2,
           "Height":600,
           "Width":1000
       },
       "AssetUrl":"6D16EE1F-73A1-4BB0-9BAA-8FD27C0B3568"
   },
   {
       "ImageSizeProfile":{
           "Id":3,
           "Height":900,
           "Width":1500
       },
       "AssetUrl":"6D16EE1F-73A1-4BB0-9BAA-8FD27C0B3568"
   }
],
                    "AssetMetadata": [
                        {
                            "Key": "3a692756-4767-4160-b35c-29859468160f",
                            "Value": "60dd4bee-eee3-4cd3-a18d-f695fffb0b1a"
                        },
                        {
                            "Key": "de8ac384-04b3-4588-ae28-d69fbb12ace7",
                            "Value": "ca9f2cd5-1662-41fd-8d6d-bd893ea02fae"
                        },
                        {
                            "Key": "fa7548ff-94e7-419d-bd52-5376eeb7279e",
                            "Value": "21d6e55a-cc96-4d1d-bf51-43c3915a2ad5"
                        }
                    ],
                    "AssetId": 1,
                    "AssetUrl": "http://127.0.0.1:10000/5e2dd075-957f-4884-8992-030d1eabcc79",
                    "IsDefault": true
                }
            ],
            "VideoAssets": [
                {
                    "AssetMetadata": [
                        {
                            "Key": "34824e92-bb05-4d52-841e-5a5567866bee",
                            "Value": "7fa6bbd4-f9ff-4715-b1d9-f82329a481b7"
                        },
                        {
                            "Key": "d90611bd-eae7-4be5-83fd-d92dcee485a8",
                            "Value": "05a8e069-372a-4695-aae4-de7a58c94b3b"
                        },
                        {
                            "Key": "0d083335-e54d-4f22-8898-596168f23bd7",
                            "Value": "27997259-69f2-41cf-bacb-07950c040231"
                        }
                    ],
                    "AssetId": 2,
                    "AssetUrl": "http://127.0.0.1:10000/ac3adc70-3394-4da7-8dfd-19a8e0edb373",
                    "IsDefault": false
                }
            ],
            "DocumentAssets": [
                {
                    "AssetMetadata": [
                        {
                            "Key": "c804de73-a2cc-48ec-ae51-8ead84251471",
                            "Value": "d5fefcbb-3912-4a0c-8f62-a0db9d22dca5"
                        },
                        {
                            "Key": "e80dcbd6-f340-49fe-9817-23e3749e51d4",
                            "Value": "41def150-a42d-478a-9915-ee5e748fb282"
                        },
                        {
                            "Key": "f7d26397-a681-45a3-bd47-d7825cde12ea",
                            "Value": "f817cb15-a7ed-4174-8030-4f534f1a3746"
                        }
                    ],
                    "AssetId": 3,
                    "AssetUrl": "http://127.0.0.1:10000/e4521bbe-6cd0-419a-ab90-73c5f06a6252",
                    "IsDefault": true
                }
            ]
        },
        "DynamicNavigation": [
            {
                "TypeId": 1,
                "TypeValueId": 1,
                "Value": "Red",
                "TypeName": "Color"
            },
            {
                "TypeId": 2,
                "TypeValueId": 4,
                "Value": "M",
                "TypeName": "Size",
                "Count":1
            },
            {
                "TypeId": 2,
                "TypeValueId": 6,
                "Value": "XL",
                "TypeName": "Size",
                "Count":1
            },
            {
                "TypeId": 2,
                "TypeValueId": 9,
                "Value": "S",
                "TypeName": "Size",
                "Count":1
            },
            {
                "TypeId": 2,
                "TypeValueId": 10,
                "Value": "XXXXXXXXL",
                "TypeName": "Size",
                "Count":1
            },
            {
                "TypeId": 3,
                "TypeValueId": 7,
                "Value": "A",
                "TypeName": "Style",
                "Count":1
            },
            {
                "TypeId": 3,
                "TypeValueId": 11,
                "Value": "A Style",
                "TypeName": "Style",
                "Count":1
            }
        ],
        "StaticNavigation": {
            "Categories": [
                {
                    "Id": 1,
                    "Name": "Sample Category 0",
                    "ShortDescription": "3b6fc358-d3b4-4da5-b617-3e17e78c8ddc",
                    "LongDescription": "1ae0428e-bc59-4119-90c1-2b9d3a042c5b",
                    "SubCategoryCount": 0,
                    "CategoryMetadata": [],
                    "ParentCategoryId": null,
                    "ParentCategoryName": ""
                },
                {
                    "Id": 66,
                    "Name": "Category 1 Sub 1 Sub 1",
                    "ShortDescription": "Category 1 Sub 1 Sub 1 Short Description",
                    "LongDescription": "Category 1 Sub 1 Sub 1 Long Description",
                    "SubCategoryCount": 0,
                    "CategoryMetadata": [],
                    "ParentCategoryId": 62,
                    "ParentCategoryName": "Category 1 Sub 1"
                }
            ],
            "Brands": [
                {
                    "Id": 1,
                    "Name": "Brand 1"
                },
                {
                    "Id": 4,
                    "Name": "Brand 4"
                }
            ],
            "Tags": [
                {
                    "Id": 1,
                    "Name": "Sample Tag 0",
                    "Description": "dfd407fb-1995-4cfc-88e1-5dce73577bec",
                    "TagMetadata": []
                },
                {
                    "Id": 2,
                    "Name": "Sample Tag 1",
                    "Description": "870e1a32-cf43-4ef2-932f-0a2d199ff108",
                    "TagMetadata": []
                },
                {
                    "Id": 3,
                    "Name": "Sample Tag 2",
                    "Description": "cb59c090-761b-47ff-9aee-9199ec746409",
                    "TagMetadata": []
                }
            ],
            "Currencies": [
                {
                    "Id": 1,
                    "Description": "USD",
                    "PriceTypeSymbol": "$"
                },
                {
                    "Id": 2,
                    "Description": "Euro",
                    "PriceTypeSymbol": "€"
                }
            ],
            "UnitTypes": [
                {
                    "Id": 1,
                    "Name": "100 Gram",
                    "Description": "100 Gram",
                    "UnitCode": "Gr"
                },
                {
                    "Id": 3,
                    "Name": "Quantity",
                    "Description": "Quantity",
                    "UnitCode": "Quantity"
                }
            ],
            "WidthRanges": [
                {
                    "DimensionTypeId": 1,
                    "DimensionTypeDescription": "Meter",
                    "Min": 1,
                    "Max": 60
                },
                {
                    "DimensionTypeId": 2,
                    "DimensionTypeDescription": "Inch",
                    "Min": 3,
                    "Max": 30
                }
            ],
            "HeightRanges": [
                {
                    "DimensionTypeId": 1,
                    "DimensionTypeDescription": "Meter",
                    "Min": 1,
                    "Max": 70
                },
                {
                    "DimensionTypeId": 2,
                    "DimensionTypeDescription": "Inch",
                    "Min": 3,
                    "Max": 40
                }
            ],
            "DepthRanges": [
                {
                    "DimensionTypeId": 1,
                    "DimensionTypeDescription": "Meter",
                    "Min": 1,
                    "Max": 50
                },
                {
                    "DimensionTypeId": 2,
                    "DimensionTypeDescription": "Inch",
                    "Min": 3,
                    "Max": 20
                }
            ],
            "WeightRanges": [
                {
                    "WeightTypeId": 1,
                    "WeightTypeDescription": "Kg",
                    "Min": 15,
                    "Max": 15
                },
                {
                    "WeightTypeId": 2,
                    "WeightTypeDescription": "LBS",
                    "Min": 25,
                    "Max": 25
                }
            ],
            "PriceRanges": [
                {
                    "PriceTypeId": 1,
                    "PriceTypeSymbol": "$",
                    "Min": 50,
                    "Max": 160.55
                }
            ],
            "DiscountPriceRanges": [
                {
                    "PriceTypeId": 1,
                    "PriceTypeSymbol": "$",
                    "Min": 50,
                    "Max": 50
                }
            ]
        }
    }
}

Response Body Description

Parameter Name Description Type
Data.StaticNavigation.DiscountPriceRanges[0..N].PriceTypeId Number
Data.StaticNavigation.DiscountPriceRanges[0..N].PriceTypeSymbol String
Data.StaticNavigation.DiscountPriceRanges[0..N].Min Number
Data.StaticNavigation.DiscountPriceRanges[0..N].Max Number
Data.StaticNavigation.PriceRanges[0..N].PriceTypeId Number
Data.StaticNavigation.PriceRanges[0..N].PriceTypeSymbol String
Data.StaticNavigation.PriceRanges[0..N].Min Number
Data.StaticNavigation.PriceRanges[0..N].Max Number
Data.StaticNavigation.WeightRanges[0..N].WeightTypeId Number
Data.StaticNavigation.WeightRanges[0..N].WeightTypeDescription String
Data.StaticNavigation.WeightRanges[0..N].Min Number
Data.StaticNavigation.WeightRanges[0..N].Max Number
Data.StaticNavigation.DepthRanges[0..N].DimensionTypeId Number
Data.StaticNavigation.DepthRanges[0..N].DimensionTypeDescription String
Data.StaticNavigation.DepthRanges[0..N].Min Number
Data.StaticNavigation.DepthRanges[0..N].Max Number
Data.StaticNavigation.HeightRanges[0..N].DimensionTypeId Number
Data.StaticNavigation.HeightRanges[0..N].DimensionTypeDescription String
Data.StaticNavigation.HeightRanges[0..N].Min Number
Data.StaticNavigation.HeightRanges[0..N].Max Number
Data.StaticNavigation.WidthRanges[0..N].DimensionTypeId Number
Data.StaticNavigation.WidthRanges[0..N].DimensionTypeDescription String
Data.StaticNavigation.WidthRanges[0..N].Min Number
Data.StaticNavigation.WidthRanges[0..N].Max Number
Data.StaticNavigation.UnitTypes[0..N].Id Number
Data.StaticNavigation.UnitTypes[0..N].Name String
Data.StaticNavigation.UnitTypes[0..N].Description String
Data.StaticNavigation.UnitTypes[0..N].UnitCode String
Data.StaticNavigation.PriceTypes[0..N].Id Id of the price type Number
Data.StaticNavigation.PriceTypes[0..N].Description Description of the price type String
Data.StaticNavigation.PriceTypes[0..N].PriceTypeSymbol Symbol for the price type. E.g. $, €, etc. String
Data.StaticNavigation.PriceTypes[0..N].DataBag Random text value bag which will be provided by the client. String
Data.StaticNavigation.Tags[0..N].Id The unique ID of the tag. Number
Data.StaticNavigation.Tags[0..N].Name The name of the tag. String
Data.StaticNavigation.Tags[0..N].Description The description of the tag. String
Data.StaticNavigation.Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Data.StaticNavigation.Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Data.StaticNavigation.Brands[0..N].Id Number
Data.StaticNavigation.Brands[0..N].Name String
Data.StaticNavigation.Categories[0..N].Id Number
Data.StaticNavigation.Categories[0..N].Name String
Data.StaticNavigation.Categories[0..N].ShortDescription String
Data.StaticNavigation.Categories[0..N].LongDescription String
Data.StaticNavigation.Categories[0..N].SubCategoryCount Number
Data.StaticNavigation.Categories[0..N].ParentCategoryId Number
Data.StaticNavigation.Categories[0..N].ParentCategoryName String
Data.StaticNavigation.Categories[0..N].CategoryMetadata[0..N].Key The key for the metadata. String
Data.StaticNavigation.Categories[0..N].CategoryMetadata[0..N].Value The value of the metadata. String
Data.DynamicNavigation[0..N].TypeId Unique ID of a dynamic field. Number
Data.DynamicNavigation[0..N].TypeValueId Unique ID of a dynamic field value. Number
Data.DynamicNavigation[0..N].Value Value of a dynamic field. String
Data.DynamicNavigation[0..N].TypeName Unique name of a dynamic field. String
Data.DynamicNavigation[0..N].Count Returns you the count of items in the current segment. Number
Data.Item.Id Number
Data.Item.RFID String
Data.Item.UUID String
Data.Item.SKU String
Data.Item.Name String
Data.Item.Model String
Data.Item.Title String
Data.Item.ShortDescription String
Data.Item.LongDescription String
Data.Item.Rating Number
Data.Item.LikeCount Number
Data.Item.DateAdded Date
Data.Item.DateModified Date
Data.Item.ItemStatusId Number
Data.Item.CategoryId Number
Data.Item.InStock Unknown
Data.Item.PublicWebLink String
Data.Item.DefaultItemId Number
Data.Item.BrandId Number
Data.Item.UnitTypeId Number
Data.Item.UnitTypeName String
Data.Item.UnitTypeCode String
Data.Item.HasVariants Unknown
Data.Item.InStoreMetadata[0..N].Key Metadata key. String
Data.Item.InStoreMetadata[0..N].Value Metadata value. String
Data.Item.DocumentAssets[0..N].AssetId Number
Data.Item.DocumentAssets[0..N].AssetUrl String
Data.Item.DocumentAssets[0..N].AssetMetadata[0..N].Key The key for the metadata. String
Data.Item.DocumentAssets[0..N].AssetMetadata[0..N].Value The value of the metadata. String
Data.Item.VideoAssets[0..N].AssetId Number
Data.Item.VideoAssets[0..N].AssetUrl String
Data.Item.VideoAssets[0..N].AssetMetadata[0..N].Key The key for the metadata. String
Data.Item.VideoAssets[0..N].AssetMetadata[0..N].Value The value of the metadata. String
Data.Item.ImageAssets[0..N].IsDefault Unknown
Data.Item.ImageAssets[0..N].AssetId Number
Data.Item.ImageAssets[0..N].AssetUrl String
Data.Item.ImageAssets[0..N].AssetMetadata[0..N].Key The key for the metadata. String
Data.Item.ImageAssets[0..N].AssetMetadata[0..N].Value The value of the metadata. String
Data.Item.ImageAssets[0..N].ResizedAssets[0..N].AssetUrl String
Data.Item.ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Id Number
Data.Item.ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Height Number
Data.Item.ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Width Number
Data.Item.Dimensions[0..N].DimensionTypeId Number
Data.Item.Dimensions[0..N].DimensionDescription String
Data.Item.Dimensions[0..N].Width Number
Data.Item.Dimensions[0..N].Height Number
Data.Item.Dimensions[0..N].Depth Number
Data.Item.Weights[0..N].WeightTypeId Number
Data.Item.Weights[0..N].WeightTypeDescription String
Data.Item.Weights[0..N].Value Number
Data.Item.Tags[0..N].Id The unique ID of the tag. Number
Data.Item.Tags[0..N].Name The name of the tag. String
Data.Item.Tags[0..N].Description The description of the tag. String
Data.Item.Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Data.Item.Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Data.Item.Prices[0..N].NormalPrice Reqular price. Number
Data.Item.Prices[0..N].DiscountPrice Discount price. Number
Data.Item.Prices[0..N].PriceTypeSymbol Unique symbol of the price type. String
Data.Item.Prices[0..N].PriceTypeId Unique ID of the price type. 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. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) There is no item found for the given item ID.