XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The Item Compare API enables a client application to get a list of item data to compare client side. The API allows a maximum of 5 items to be compared in a request.

Request

[
   1,
   2,
   3
]
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/catalog/itemcompare

Request Body Description

An array of unique IDs of items to compare.

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": {
        "Items": [
            {
                "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,
                "UnitTypeCode": "Quantity",
                "UnitTypeName": "Quantity",
                "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": [
                    {
                        "NormalPrice": 100.55,
                        "DiscountPrice": null,
                        "CurrencySymbol": "€",
                        "CurrencyId": 2
                    },
                    {
                        "NormalPrice": 140.55,
                        "DiscountPrice": null,
                        "CurrencySymbol": "$",
                        "CurrencyId": 1
                    }
                ],
                "Tags": [],
                "Weights": [
                    {
                        "WeightTypeId": 1,
                        "WeightTypeDescription": "Kg",
                        "Value": 20
                    },
                    {
                        "WeightTypeId": 1,
                        "WeightTypeDescription": "Kg",
                        "Value": 40
                    }
                ],
                "Dimensions": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionDescription": "Meter",
                        "Width": 1,
                        "Height": 1,
                        "Depth": 1
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionDescription": "Inch",
                        "Width": 3,
                        "Height": 3,
                        "Depth": 3
                    }
                ],
                "Metadata": []
            },
            {
                "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": 2,
                "BrandId": 2,
                "UnitTypeId": 2,
                "UnitTypeCode": "Kg",
                "UnitTypeName": "250 Kilogram",
                "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": [
                    {
                        "NormalPrice": 10.55,
                        "DiscountPrice": null,
                        "CurrencySymbol": "$",
                        "CurrencyId": 1
                    },
                    {
                        "NormalPrice": 20.55,
                        "DiscountPrice": 15,
                        "CurrencySymbol": "€",
                        "CurrencyId": 2
                    }
                ],
                "Tags": [
                    {
                        "Id": 2,
                        "Name": "3e129d70-2308-4dc5-bd33-c389b92859d2",
                        "Description": "3e129d70-2308-4dc5-bd33-c389b92859d2"
                    }
                ],
                "Weights": [],
                "Dimensions": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionDescription": "Meter",
                        "Width": 11,
                        "Height": 11,
                        "Depth": 11
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionDescription": "Inch",
                        "Width": 5,
                        "Height": 5,
                        "Depth": 5
                    }
                ],
                "Metadata": []
            },
            {
                "Id": 3,
                "RFID": null,
                "UUID": null,
                "SKU": null,
                "Name": "D1V2 Red-M-A Style",
                "Model": "Model Name",
                "Title": "D1 Title",
                "ShortDescription": "D1V2 Short Description",
                "LongDescription": null,
                "Rating": null,
                "LikeCount": 55,
                "CategoryId": 66,
                "InStock": true,
                "PublicWebLink": null,
                "DefaultItemId": 1,
                "BrandId": 1,
                "UnitTypeId": 3,
                "UnitTypeCode": "Quantity",
                "UnitTypeName": "Quantity",
                "DynamicAttributes": [
                    {
                        "TypeId": 1,
                        "TypeValueId": 1,
                        "Value": "Red",
                        "TypeName": "Color"
                    },
                    {
                        "TypeId": 2,
                        "TypeValueId": 4,
                        "Value": "M",
                        "TypeName": "Size"
                    },
                    {
                        "TypeId": 3,
                        "TypeValueId": 7,
                        "Value": "A",
                        "TypeName": "Style"
                    }
                ],
                "Prices": [
                    {
                        "NormalPrice": 111.55,
                        "DiscountPrice": null,
                        "CurrencySymbol": "€",
                        "CurrencyId": 2
                    },
                    {
                        "NormalPrice": 160.55,
                        "DiscountPrice": null,
                        "CurrencySymbol": "$",
                        "CurrencyId": 1
                    }
                ],
                "Tags": [],
                "Weights": [
                    {
                        "WeightTypeId": 1,
                        "WeightTypeDescription": "Kg",
                        "Value": 20
                    },
                    {
                        "WeightTypeId": 1,
                        "WeightTypeDescription": "Kg",
                        "Value": 40
                    }
                ],
                "Dimensions": [
                    {
                        "DimensionTypeId": 1,
                        "DimensionDescription": "Meter",
                        "Width": 1,
                        "Height": 1,
                        "Depth": 1
                    },
                    {
                        "DimensionTypeId": 2,
                        "DimensionDescription": "Inch",
                        "Width": 3,
                        "Height": 3,
                        "Depth": 3
                    }
                ],
                "Metadata": []
            }
        ],
        "TotalItemCount": 3,
        "DynamicNavigation": null,
        "StaticNavigation": null
    }
}

Response Body Description

Parameter Name Description Type
Data.TotalItemCount Total item count in the items collection. Number
Data.DynamicNavigation Dynamic navigation field will always be null in this operation. Array
Data.StaticNavigation Static navigation field will always be null in this operation. Object
Data.Items[0..N].Id The unique ID of the item Number
Data.Items[0..N].RFID The radio frequency ID of the item. String
Data.Items[0..N].UUID The universally unique ID of the item. String
Data.Items[0..N].SKU Stock keeping unit of the item. String
Data.Items[0..N].Name Name of the item. String
Data.Items[0..N].Model Model of the item. String
Data.Items[0..N].Title Title of the item. String
Data.Items[0..N].ShortDescription Short description of the item. String
Data.Items[0..N].LongDescription Long description of the item. String
Data.Items[0..N].Rating Rating of the item. Number
Data.Items[0..N].LikeCount Like count of the item. Number
Data.Items[0..N].CategoryId The unique ID of a category assigned to the item. Number
Data.Items[0..N].InStock The Boolean field indicating if the item is in stock or not. Boolean
Data.Items[0..N].PublicWebLink Public web link of the item. String
Data.Items[0..N].DefaultItemId The ID of the default item in the associated variant list. If the DefaultItemID equals to the ID, the current item is a default item in its variant list. Number
Data.Items[0..N].BrandId The unique ID of a brand assigned to the item. Number
Data.Items[0..N].UnitTypeId ID of item’s unit type. Number
Data.Items[0..N].UnitTypeName The name of the type used to define a unit of the item (e.g.: kilogram). String
Data.Items[0..N].UnitTypeCode The code of the type used to define a unit of item (e.g. kg). String
Data.Items[0..N].HasVariants The Boolean field indicating if the item has variants or doesn’t. Boolean
Data.Items[0..N].DocumentAssets[0..N].AssetMetadata A list of key/value metadata pairs Array
Data.Items[0..N].DocumentAssets[0..N].AssetId The unique ID of the asset. Number
Data.Items[0..N].DocumentAssets[0..N].AssetUrl The unique URL of the asset. String
Data.Items[0..N].DocumentAssets[0..N].IsDefault A boolean field indicating whether the asset is default or not. Boolean
Data.Items[0..N].VideoAssets[0..N].AssetMetadata A list of key/value metadata pairs Array
Data.Items[0..N].VideoAssets[0..N].AssetId The unique ID of the asset. Number
Data.Items[0..N].VideoAssets[0..N].AssetUrl The unique URL of the asset. String
Data.Items[0..N].VideoAssets[0..N].IsDefault A boolean field indicating whether the asset is default or not. Boolean
Data.Items[0..N].ImageAssets[0..N].IsDefault Boolean field indicating whether this asset is the default image of the related object or not. Boolean
Data.Items[0..N].ImageAssets[0..N].AssetId The unique ID of the asset. Number
Data.Items[0..N].ImageAssets[0..N].AssetUrl The unique URL of the asset. String
Data.Items[0..N].ImageAssets[0..N].AssetMetadata[0..N].Key The key for the metadata. String
Data.Items[0..N].ImageAssets[0..N].AssetMetadata[0..N].Value The value of the metadata. String
Data.Items[0..N].ImageAssets[0..N].ResizedAssets[0..N].AssetUrl The unique URL of the asset. String
Data.Items[0..N].ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Id The unique ID of the resized asset size profile. Number
Data.Items[0..N].ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Height Height of the resized asset. Number
Data.Items[0..N].ImageAssets[0..N].ResizedAssets[0..N].ImageSizeProfile.Width Width of the resized asset. Number
Data.Items[0..N].Metadata[0..N].Key The key for the metadata. String
Data.Items[0..N].Metadata[0..N].Value The value of the metadata. String
Data.Items[0..N].Dimensions[0..N].DimensionTypeId The unique ID of the dimension type to define the dimension. Number
Data.Items[0..N].Dimensions[0..N].DimensionDescription The description of the dimension type to define the dimension. String
Data.Items[0..N].Dimensions[0..N].Width The width value of the item. Number
Data.Items[0..N].Dimensions[0..N].Height The hight value of the item. Number
Data.Items[0..N].Dimensions[0..N].Depth The depth value of the item. Number
Data.Items[0..N].Weights[0..N].WeightTypeId The unique ID of the weight type to define the weight. Number
Data.Items[0..N].Weights[0..N].WeightTypeDescription The description of the weight type to define the weight. String
Data.Items[0..N].Weights[0..N].Value The weight value of the item. Number
Data.Items[0..N].Tags[0..N].Id The unique ID of the tag. Number
Data.Items[0..N].Tags[0..N].Name The name of the tag. String
Data.Items[0..N].Tags[0..N].Description The description of the tag. String
Data.Items[0..N].Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Data.Items[0..N].Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Data.Items[0..N].Prices[0..N].NormalPrice The regular price of the item. Number
Data.Items[0..N].Prices[0..N].DiscountPrice The discounted price of the item. Number
Data.Items[0..N].Prices[0..N].CurrencySymbol The code of the currency used to define the price. String
Data.Items[0..N].Prices[0..N].CurrencyId The unique ID of the currency used to define the price. Number
Data.Items[0..N].DynamicAttributes[0..N].TypeId Unique ID of a dynamic field. Number
Data.Items[0..N].DynamicAttributes[0..N].TypeValueId Unique ID of a dynamic field value. Number
Data.Items[0..N].DynamicAttributes[0..N].Value Value of a dynamic field. String
Data.Items[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 POST operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Invalid DelimitedItemIds parameter.
404 (Not Found) No item found to compare.