Last Updated: August 26, 2016
Fetching a Single Item
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
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. |