Last Updated: May 05, 2016
Fetching an item by its item id
The API provides to fetch an item by its item id from the backend.
Request
HTTP Method | Resource URI |
---|---|
GET | https://{tenantName}.api.xomni.com/private/catalog/item/{itemId} |
URI Parameters
Parameter Name | Description | Type | Conditions |
---|---|---|---|
itemId | Unique ID for the item. | 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
Response Body Description
Parameter Name | Description | Type |
---|---|---|
Id | The unique ID of the item | Number |
RFID | The radio frequency id of the item | String |
UUID | The universally unique ID of the item | String |
SKU | Stock keeping unit of the item | String |
Name | Name of the item | String |
Model | Model of the item | String |
Title | Title of the item | String |
ShortDescription | Short description of the item | String |
LongDescription | Long description of the item | String |
Rating | Rating of the item | Number |
LikeCount | Like count of the item | Number |
DateAdded | Item added date | Date |
DateModified | Item last modification date | Date |
ItemStatusId | Status id of the item. | Number |
CategoryId | The unique Id of a category assigned to the item. | Number |
InStock | The boolean field indicating if the item is in stock or not. | Unknown |
PublicWebLink | Public web link of the item | String |
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 |
BrandId | The unique Id of a brand assigned to the item. | Number |
UnitTypeId | Id of item’s unit type | Number |
Dimensions[0..N].DimensionId | The unique ID of the dimension. | Number |
Dimensions[0..N].DimensionTypeId | The unique ID of the dimension type to define the dimension. | Number |
Dimensions[0..N].DimensionDescription | The description of the dimension type to define the dimension. | String |
Dimensions[0..N].Width | The width value of the item. | Number |
Dimensions[0..N].Height | The hight value of the item. | Number |
Dimensions[0..N].Depth | The depth value of the item. | Number |
Weights[0..N].WeightId | The unique ID of the weight. | Number |
Weights[0..N].WeightTypeId | The unique ID of the weight type to define the weight. | Number |
Weights[0..N].WeightTypeDescription | The description of the weight type used to define the weight. | String |
Weights[0..N].Value | The weight value of the item. | Number |
Tags[0..N].Id | The unique ID of the tag. | Number |
Tags[0..N].Name | The name of the tag. | String |
Tags[0..N].Description | The description of the tag. | String |
Tags[0..N].TagMetadata[0..N].Key | The key for the metadata. | String |
Tags[0..N].TagMetadata[0..N].Value | The value of the metadata. | String |
Prices[0..N].PriceId | Unique id of the price. | Number |
Prices[0..N].ItemId | Unique id of the item. | Number |
Prices[0..N].NormalPrice | The regular price of the item. | Number |
Prices[0..N].DiscountPrice | The discounted price of the item. | Number |
Prices[0..N].PriceTypeSymbol | The code of the price type used to define the price. | String |
Prices[0..N].PriceTypeId | The unique Id of the price type used to define the price. | Number |
DynamicAttributes[0..N].TypeId | Unique ID of a dynamic field. | Number |
DynamicAttributes[0..N].TypeValueId | Unique ID of a dynamic field value. | Number |
DynamicAttributes[0..N].Value | Value of a dynamic field. | String |
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. Possible response status codes are as listed below:
Status Code | Description |
---|---|
404 (Not Found) | Item is not found. |