(Quick Reference)
Service: Show an item
Description: Returns the requested item in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/items/{id}:
https://BASE_URL/api/VERSION/items/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired item | Long/String | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 706,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"description": "",
"itemCategoryId": 2,
"itemCategory": {
"id": 2,
"reference": "Ref-01",
"name": "Jewelry",
"href": "/api/v1.0/itemCategories/2"
},
"itemImages": [{
"imageOrder": 1,
"smallImage": "BASE_URL/entity1-1450169988465/photoItem/0009afbb-ff5d-464e-bebb-4073ae7f1bc8-small.png",
"thumbnailImage": "BASE_URL/entity1-1450169988465/photoItem/0009afbb-ff5d-464e-bebb-4073ae7f1bc8-thumbnail.png",
"originalImage": "BASE_URL/entity1-1450169988465/photoItem/0009afbb-ff5d-464e-bebb-4073ae7f1bc8.png"
}],
"displayOrder": 1,
"volumeInLiter": null,
"isActive": false,
"isNew": true,
"videoUrl": "",
"videoSize": 0,
"formattedVideoSize": "0",
"pdfUrl": "",
"pdfSize": 0,
"formattedPdfSize": "0",
"similarItems": [],
"parentId": null,
"parentItem": null,
"hasDeclination": false,
"relatedItems": [],
"itemAttributes": [],
"tags": [
"bracelet",
"jewelry"
],
"hasSerialNumbers": false,
"serialNumbers": null,
"organization": "entity1",
"dateCreated": "2016-08-11T09:17:30Z",
"lastUpdated": "2016-08-11T09:17:30Z"
} Failure Output
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The item with the id 7065 doesn't exist."
}Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
