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 object has multiple fields and options available that can be used separately or combined.

Request

{
    "Skip":0,
    "Take":10,
    "OrderedPropertyName":null,
    "OrderBy":null,
    "IncludeStaticNavigation":true,
    "IncludeDynamicNavigation":true,
    "DefaultItemId":null,
    "RFID":null,
    "UUID":null,
    "Name":null,
    "SKU":null,
    "CategoryId":null,
    "BrandId":null,
    "Model":null,
    "Title":null,
    "MinWidth":null,
    "MaxWidth":null,
    "MinHeight":null,
    "MaxHeight":null,
    "MinWeigth":null,
    "MaxWeigth":null,
    "MinDepth":null,
    "MaxDepth":null,
    "MinPrice":null,
    "MaxPrice":null,
    "DimensionTypeId":null,
    "WeightTypeId":null,
    "TagId":null,
    "DelimitedDynamicAttributeValues":"1:1;",
    "IncludeOnlyMasterItems":false,
    "IncludeItemStaticProperties":true,
    "IncludeItemDynamicProperties":true,
    "ImageAssetDetail":4,
    "VideoAssetDetail":4,
    "DocumentAssetDetail":4,
    "TagQuery":null,
    "ItemIds":[
	   1,
	   2,
	   3
	]
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/catalog/items?includeItemInStoreMetadata={includeItemInStoreMetadata}

Request Body Description

Parameter Name Description Type Conditions
ItemIds List of item IDs to search. Array
Skip The number of the items in the collection to skip before executing a select (mandatory). Number
Required
Take The number of items that should be fetched from the collection (mandatory). Number
Required
OrderedPropertyName The property name used to order the collection. Possible values are “Name”, “SKU”, “Model”, “Title”, “Rating”, “LikeCount”, “InStock”, “DiscountPrice” and "NormalPrice". In case of “DiscountPrice” or "NormalPrice" ordering the search request should include a valid value for the “CurrencyID” property as well. String
Optional.
OrderBy Indicates the direction of ordering specified by the “OrderedPropertyName”. The possible values are “asc” and “desc”. String
Optional.
IncludeItemStaticProperties A Boolean filed indicating whether the response contains items static properties (like SKU, RFID, CategoryId etc. except for Dynamic Attributes). Boolean
Optional.
IncludeItemDynamicProperties A Boolean filed indicating whether the response contains items dynamic properties (like DynamicAttributes). Boolean
Optional.
DocumentAssetDetail An integer field indicating if the response contains item image assets (see Possible values for DocumentAssetDetail below). Number
Optional.
VideoAssetDetail An integer field indicating whether the response contains item image assets (see Possible values for VideoAssetDetail below). Number
Optional.
ImageAssetDetail An integer field indicating whether the response contains item image assets (see Possible values for ImageAssetDetail below). Number
Optional.
IncludeStaticNavigation A Boolean filed indicating whether the response contains items static navigations. Boolean
Optional.
IncludeDynamicNavigation A Boolean filed indicating whether the response contains items dynamic navigations. Boolean
Optional.
DefaultItemId The unique ID of the default item in the set of variant items. Number
Optional.
RFID The radio frequency ID of the item. String
Optional.
UUID The universally unique ID of the item. String
Optional.
Name Name of the item. String
Optional.
SKU Stock keeping unit of the item. String
Optional.
CategoryId The unique CategoryId of the category assigned to the item. Number
Optional.
BrandId The unique BrandId of the Brand assigned to the item. Number
Optional.
Model Model of the item. String
Optional.
Title Title of the item. String
Optional.
MinWidth Minimum width criteria. Number
Optional.
MaxWidth Maximum width criteria. Number
Optional.
MinHeight Minimum height criteria. Number
Optional.
MaxHeight Maximum height criteria. Number
Optional.
MinWeight Minimum weight criteria. Number
Optional.
MaxWeight Maximum weight criteria. Number
Optional.
MinDepth Minimum depth criteria. Number
Optional.
MaxDepth Maximum depth criteria. Number
Optional.
MinPrice Minimum price criteria. Number
Optional.
MaxPrice Maximum price criteria. Number
Optional.
DimensionTypeId Dimension type ID of minimum and maximum weight, height, depth criteria. Number
Optional.
WeightTypeId Weight type ID of minimum and maximum weight criteria. Number
Optional.
TagId The tagId of a Tag assigned to the item. Number
Optional.
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
Optional.
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
Optional.
TagQuery A string field that filters on tags like a where clause query (Ex: "(TagIds: 1 OR 2 OR 3)"). String
Optional.
IncludePassiveItems A Boolean filed indicating whether the response contains passive items. Boolean
Optional.

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
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==
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

{
    "Data": {
        "SearchRequest": {
            "Skip": 0,
            "Take": 10,
            "OrderedPropertyName": null,
            "OrderBy": null,
            "IncludeStaticNavigation": true,
            "IncludeDynamicNavigation": true,
            "DefaultItemId": null,
            "RFID": null,
            "UUID": null,
            "Name": null,
            "SKU": null,
            "CategoryId": null,
            "BrandId": null,
            "Model": null,
            "Title": null,
            "MinWidth": null,
            "MaxWidth": null,
            "MinHeight": null,
            "MaxHeight": null,
            "MinWeigth": null,
            "MaxWeigth": null,
            "MinDepth": null,
            "MaxDepth": null,
            "MinPrice": null,
            "MaxPrice": null,
            "DimensionTypeId": null,
            "WeightTypeId": null,
            "TagId": null,
            "DelimitedDynamicAttributeValues": "1:1;",
            "IncludeOnlyMasterItems": false
        },
        "SearchResult": {
            "Items": [
                {
                    "Id": 7,
                    "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": 80,
                    "CategoryId": 67,
                    "InStock": true,
                    "PublicWebLink": null,
                    "DefaultItemId": 2,
                    "BrandId": 2,
                    "UnitTypeId": 3,
                    "UnitTypeCode": "Quantity",
                    "UnitTypeName": "Quantity",
                    "DynamicAttributes": [
                        {
                            "TypeId": 2,
                            "TypeValueId": 5,
                            "Value": "L",
                            "TypeName": "Size"
                        },
                        {
                            "TypeId": 3,
                            "TypeValueId": 8,
                            "Value": "B",
                            "TypeName": "Style"
                        }
                    ],
                    "Prices": [
                        {
                            "NormalPrice": 140.55,
                            "DiscountPrice": 50,
                            "CurrencySymbol": "$",
                            "CurrencyId": 1
                        }
                    ],
                    "Tags": [],
                    "Weights": [
                        {
                            "WeightTypeId": 1,
                            "WeightTypeDescription": "Kg",
                            "Value": 20
                        },
                        {
                            "WeightTypeId": 2,
                            "WeightTypeDescription": "LBS",
                            "Value": 40
                        }
                    ],
                    "Dimensions": [
                        {
                            "DimensionTypeId": 1,
                            "DimensionDescription": "Meter",
                            "Width": 11,
                            "Height": 11,
                            "Depth": 11
                        },
                        {
                            "DimensionTypeId": 2,
                            "DimensionDescription": "Inch",
                            "Width": 5,
                            "Height": 5,
                            "Depth": 5
                        }
                    ],
                    "Metadata": [],
                    "ImageAssets": [
                        {
"ResizedAssets":[
   {
       "CreatedDate":"2013-10-04T10:39:50.027",
       "ImageSizeProfile":{
           "Id":1,
           "Height":300,
           "Width":500
       },
       "AssetUrl":"6D16EE1F-73A1-4BB0-9BAA-8FD27C0B3568"
   },
   {
       "CreatedDate":"2013-10-04T10:39:50.027",
       "ImageSizeProfile":{
           "Id":2,
           "Height":600,
           "Width":1000
       },
       "AssetUrl":"6D16EE1F-73A1-4BB0-9BAA-8FD27C0B3568"
   },
   {
       "CreatedDate":"2013-10-04T10:39:50.027",
       "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
                        }
                    ],
                    "ImageAssets": [
                        {
                            "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,
		       "ResizedAssets":[
              		{
		                  "ImageSizeProfile":{
                     				 "Id":1,
				                      "Height":100,
				                      "Width":200
                  				      },
                                       "AssetUrl":"http://xomnistaging.blob.core.windows.net/resizedassets/test-resizedasset"
              		}
           	      ],
                        }
                    ],
                    "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
                        }
                    ]
                },
                {
                    "Id": 8,
                    "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": 80,
                    "CategoryId": 67,
                    "InStock": true,
                    "PublicWebLink": null,
                    "DefaultItemId": 2,
                    "BrandId": 2,
                    "UnitTypeId": 3,
                    "UnitTypeCode": "Quantity",
                    "UnitTypeName": "Quantity",
                    "DynamicAttributes": [
                        {
                            "TypeId": 2,
                            "TypeValueId": 5,
                            "Value": "L",
                            "TypeName": "Size"
                        },
                        {
                            "TypeId": 3,
                            "TypeValueId": 8,
                            "Value": "B",
                            "TypeName": "Style"
                        }
                    ],
                    "Prices": [
                        {
                            "NormalPrice": 140.55,
                            "DiscountPrice": 50,
                            "PriceTypeSymbol": "$",
                            "PriceTypeId": 1
                        }
                    ],
                    "Tags": [],
                    "Weights": [],
                    "Dimensions": [
                        {
                            "DimensionTypeId": 1,
                            "DimensionDescription": "Meter",
                            "Width": 11,
                            "Height": 11,
                            "Depth": 11
                        },
                        {
                            "DimensionTypeId": 2,
                            "DimensionDescription": "Inch",
                            "Width": 5,
                            "Height": 5,
                            "Depth": 5
                        }
                    ],
                    "Metadata": [],
                    "ImageAssets": [],
                    "VideoAssets": [],
                    "DocumentAssets": []
                }
            ],
            "TotalItemCount": 2,
            "DynamicNavigation": [
                {
                    "TypeId": 1,
                    "TypeValueId": 1,
                    "Value": "Red",
                    "TypeName": "Color"
                },
                {
                    "TypeId": 2,
                    "TypeValueId": 4,
                    "Value": "M",
                    "TypeName": "Size"
                },
                {
                    "TypeId": 2,
                    "TypeValueId": 5,
                    "Value": "L",
                    "TypeName": "Size"
                },
                {
                    "TypeId": 2,
                    "TypeValueId": 6,
                    "Value": "XL",
                    "TypeName": "Size"
                },
                {
                    "TypeId": 3,
                    "TypeValueId": 7,
                    "Value": "A",
                    "TypeName": "Style"
                },
                {
                    "TypeId": 3,
                    "TypeValueId": 8,
                    "Value": "B",
                    "TypeName": "Style"
                },
                {
                    "TypeId": 2,
                    "TypeValueId": 9,
                    "Value": "S",
                    "TypeName": "Size"
                }
            ],
            "StaticNavigation": {
                "Categories": [
                    {
                        "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,
                        "ParentCategoryId": 62,
                        "ParentCategoryName": "Category 1 Sub 1"
                    },
                    {
                        "Id": 67,
                        "Name": "Category 1 Sub 1 Sub 2",
                        "ShortDescription": "Category 1 Sub 1 Sub 1 Short Description",
                        "LongDescription": "Category 1 Sub 1 Sub 1 Long Description",
                        "SubCategoryCount": 0,
                        "ParentCategoryId": 62,
                        "ParentCategoryName": "Category 1 Sub 1"
                    }
                ],
                "Brands": [
                    {
                        "Id": 1,
                        "Name": "Brand 1"
                    },
                    {
                        "Id": 2,
                        "Name": "Brand 2"
                    }
                ],
                "Tags": [
                    {
                        "Id": 2,
                        "Name": "Sample Tag 1",
                        "Description": "3e129d70-2308-4dc5-bd33-c389b92859d2"
                    }
                ],
                "PriceTypes": [
                    {
                        "Id": 1,
                        "Description": "USD",
                        "PriceTypeSymbol": "$"
                    },
                    {
                        "Id": 2,
                        "Description": "Euro",
                        "PriceTypeSymbol": "€"
                    }
                ],
                "UnitTypes": [
                    {
                        "Id": 2,
                        "Name": "250 Kilogram",
                        "Description": "1 Kilogram",
                        "UnitCode": "Kg"
                    },
                    {
                        "Id": 3,
                        "Name": "Quantity",
                        "Description": "Quantity",
                        "UnitCode": "Quantity"
                    }
                ],
                "WidthRanges": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionTypeDescription": "Meter",
                        "Min": 11,
                        "Max": 11
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionTypeDescription": "Inch",
                        "Min": 5,
                        "Max": 5
                    }
                ],
                "HeightRanges": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionTypeDescription": "Meter",
                        "Min": 11,
                        "Max": 11
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionTypeDescription": "Inch",
                        "Min": 5,
                        "Max": 5
                    }
                ],
                "DepthRanges": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionTypeDescription": "Meter",
                        "Min": 11,
                        "Max": 11
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionTypeDescription": "Inch",
                        "Min": 5,
                        "Max": 5
                    }
                ],
                "WeightRanges": [],
                "PriceRanges": [
                    {
                        "PriceTypeId": 1,
                        "PriceTypeSymbol": "$",
                        "Min": 10.55,
                        "Max": 8888
                    }
                ],
                "DiscountPriceRanges": [
                    {
                        "PriceTypeId": 1,
                        "PriceTypeSymbol": "$",
                        "Min": 50,
                        "Max": 888
                    }
                ]
            }
        }
    }
}

Response Body Description

Parameter Name Description Type
Data.SearchResult.StaticNavigation.DiscountPriceRanges[0..N].PriceTypeId This is the unique ID for the price type. Number
Data.SearchResult.StaticNavigation.DiscountPriceRanges[0..N].PriceTypeSymbol Symbol of the price type. String
Data.SearchResult.StaticNavigation.DiscountPriceRanges[0..N].Min Minimum price value. Number
Data.SearchResult.StaticNavigation.DiscountPriceRanges[0..N].Max Maximum price value. Number
Data.SearchResult.StaticNavigation.PriceRanges[0..N].PriceTypeId This is the unique ID for the price type. Number
Data.SearchResult.StaticNavigation.PriceRanges[0..N].PriceTypeSymbol Symbol of the price type. String
Data.SearchResult.StaticNavigation.PriceRanges[0..N].Min Minimum price value. Number
Data.SearchResult.StaticNavigation.PriceRanges[0..N].Max Maximum price value. Number
Data.SearchResult.StaticNavigation.WeightRanges[0..N].WeightTypeId The unique ID of the weight type to define the weight. Number
Data.SearchResult.StaticNavigation.WeightRanges[0..N].WeightTypeDescription The description of the weight type to define the weight. String
Data.SearchResult.StaticNavigation.WeightRanges[0..N].Min Minimum weight value. Number
Data.SearchResult.StaticNavigation.WeightRanges[0..N].Max Maximum weight value. Number
Data.SearchResult.StaticNavigation.DepthRanges[0..N].DimensionTypeId The unique id of the dimension type to define the dimension Number
Data.SearchResult.StaticNavigation.DepthRanges[0..N].DimensionTypeDescription The description of the dimension type to define the dimension String
Data.SearchResult.StaticNavigation.DepthRanges[0..N].Min The width value of the item. Number
Data.SearchResult.StaticNavigation.DepthRanges[0..N].Max The hight value of the item. Number
Data.SearchResult.StaticNavigation.HeightRanges[0..N].DimensionTypeId The unique id of the dimension type to define the dimension Number
Data.SearchResult.StaticNavigation.HeightRanges[0..N].DimensionTypeDescription The description of the dimension type to define the dimension String
Data.SearchResult.StaticNavigation.HeightRanges[0..N].Min The width value of the item. Number
Data.SearchResult.StaticNavigation.HeightRanges[0..N].Max The hight value of the item. Number
Data.SearchResult.StaticNavigation.WidthRanges[0..N].DimensionTypeId The unique id of the dimension type to define the dimension Number
Data.SearchResult.StaticNavigation.WidthRanges[0..N].DimensionTypeDescription The description of the dimension type to define the dimension String
Data.SearchResult.StaticNavigation.WidthRanges[0..N].Min The width value of the item. Number
Data.SearchResult.StaticNavigation.WidthRanges[0..N].Max The hight value of the item. Number
Data.SearchResult.StaticNavigation.UnitTypes[0..N].Id This is the unique ID for a unit type. Number
Data.SearchResult.StaticNavigation.UnitTypes[0..N].Name Name of the unit type. String
Data.SearchResult.StaticNavigation.UnitTypes[0..N].Description Description of the unit type. String
Data.SearchResult.StaticNavigation.UnitTypes[0..N].UnitCode Unit code of the unit type. (For example, kg for kilogram) String
Data.SearchResult.StaticNavigation.Prices[0..N].Id This is the unique ID for the currency. Number
Data.SearchResult.StaticNavigation.Prices[0..N].Description Description of the currency. String
Data.SearchResult.StaticNavigation.Prices[0..N].CurrencySymbol Currency symbol of the currency String
Data.SearchResult.StaticNavigation.Tags[0..N].Id The unique ID of the tag. Number
Data.SearchResult.StaticNavigation.Tags[0..N].Name The name of the tag. String
Data.SearchResult.StaticNavigation.Tags[0..N].Description The description of the tag. String
Data.SearchResult.StaticNavigation.Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Data.SearchResult.StaticNavigation.Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Data.SearchResult.StaticNavigation.Brands[0..N].Id The unique ID of the brand. Number
Data.SearchResult.StaticNavigation.Brands[0..N].Name The name of the brand. String
Data.SearchResult.StaticNavigation.Categories[0..N].Id This is the unique ID for the category. Number
Data.SearchResult.StaticNavigation.Categories[0..N].Name The name of the category. String
Data.SearchResult.StaticNavigation.Categories[0..N].ShortDescription The short description of the category. String
Data.SearchResult.StaticNavigation.Categories[0..N].LongDescription The long description of the category. String
Data.SearchResult.StaticNavigation.Categories[0..N].SubCategoryCount The count of subcategories of this category. Number
Data.SearchResult.StaticNavigation.Categories[0..N].ParentCategoryId The unique id of the parent category of the current category Number
Data.SearchResult.StaticNavigation.Categories[0..N].ParentCategoryName The name of the parent category of the current category String
Data.SearchResult.StaticNavigation.Categories[0..N].CategoryMetadata[0..N].Key The key for the metadata. String
Data.SearchResult.StaticNavigation.Categories[0..N].CategoryMetadata[0..N].Value The value of the metadata. String
Data.SearchResult.DynamicNavigation[0..N].TypeId Unique ID of a dynamic field. Number
Data.SearchResult.DynamicNavigation[0..N].TypeValueId Unique ID of a dynamic field value. Number
Data.SearchResult.DynamicNavigation[0..N].Value Value of a dynamic field. String
Data.SearchResult.DynamicNavigation[0..N].TypeName Unique name of a dynamic field. String
Data.SearchRequest.DefaultItemId The unique ID of the default item in the set of variant items. Number
Data.SearchRequest.RFID The radio frequency ID of the item. String
Data.SearchRequest.UUID The universally unique ID of the item. String
Data.SearchRequest.Name Name of the item. String
Data.SearchRequest.SKU Stock keeping unit of the item. String
Data.SearchRequest.CategoryId The unique CategoryId of the category assigned to the item. Number
Data.SearchRequest.BrandId The unique BrandId of the Brand assigned to the item. Number
Data.SearchRequest.Model Model of the item. String
Data.SearchRequest.Title Title of the item. String
Data.SearchRequest.MinWidth Minimum width criteria. Number
Data.SearchRequest.MaxWidth Maximum width criteria. Number
Data.SearchRequest.MinHeight Minimum height criteria. Number
Data.SearchRequest.MaxHeight Minimum height criteria. Number
Data.SearchRequest.MinWeight Minimum weight criteria. Number
Data.SearchRequest.MaxWeight Maximum weight criteria. Number
Data.SearchRequest.MinDepth Minimum depth criteria. Number
Data.SearchRequest.MaxDepth Minimum depth criteria. Number
Data.SearchRequest.MinPrice Minimum price criteria. Number
Data.SearchRequest.MaxPrice Maximum price criteria. Number
Data.SearchRequest.DimensionTypeId Dimension type ID of minimum and maximum weight, height, depth criteria. Number
Data.SearchRequest.WeightTypeId Weight type ID of minimum and maximum weight criteria. Number
Data.SearchRequest.TagId The tagId of a Tag assigned to the item. Number
Data.SearchRequest.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
Data.SearchRequest.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
Data.SearchRequest.TagQuery A string field that filters on tags like a where clause query (Ex: "(TagIds: 1 OR 2 OR 3)"). String
Data.SearchRequest.IncludePassiveItems A Boolean filed indicating whether the response contains passive items. Boolean

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
400 (Bad Request) Invalid ordered property name.
400 (Bad Request) Currency ID is missing in request headers (required when ordering items by price).
400 (Bad Request) Currency Id is missing in request headers (required when performing price range filtering).
400 (Bad Request) Take parameter is not positive integer.
400 (Bad Request) WeightType Id is missing in request body (required when performing weight range filtering).
400 (Bad Request) DimensionTypeId is missing in request body (required when performing dimensions range filtering).