(Quick Reference) Service: Update an item

Description: Returns the updated item in json format when successful. Returns a json response, describing the failure condition when unsuccessful.



URL with external_id:


Method: POST

Request content type: application/x-www-form-urlencoded or multipart/form-data


NameDescriptionTypeRequiredExample values
idThe ID of the desired itemInteger/Stringyes123
reference Stringyes 
name Stringyes 
description Stringno 
categoryIdThe ID of the item category.Long/String- 
isActiveBy default, it is set to trueBooleannotrue, false
isNew Booleannotrue, false
displayOrder Integerno 
volumeInLiter Doubleno1.5
pdfFile pdfno 
video webm, avi, mpeg , quicktimeno 
image1 jpg, gif, png, bmpno 
image2 jpg, gif, png, bmpno 
image3 jpg, gif, png, bmpno 
tagsTags should not contain comma seperatorJSON listno["bracelet","jewelry"]
similarItemsList of similar items idJSON listno[750,751]
hasSerialNumbersBy default, it is set to falseBooleannotrue, false
hasDeclinationBy default, it is set to falseBooleannotrue, false

If item has already sold or reserved serial numbers, hasSerialNumbers parameter will be fixed to true.

Declination parameters (optional):

Parameter name: attributeValues

Parameter type: a json structure

NameDescriptionTypeRequiredExample values
itemReference Stringyes 
attributeValueId Longyes 

Success Output

Status: HTTP/1.1 200 OK

  "id": 706,
  "reference": "bracelet-GRP09062",
  "name": "Knot Band Bracelet",
  "description": null,
  "itemCategoryId": 2,
  "itemCategory": {
    "id": 2,
    "reference": "Ref-01",
    "name": "Jewelry",
    "href": "/api/v1.0/itemCategories/2"
  "itemImages": null,
  "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": [],
  "hasSerialNumbers": false,
  "serialNumbers": null,
  "organization": "entity1",
  "dateCreated": "2016-08-11T09:17:30Z",
  "lastUpdated": "2016-08-12T10:17:30Z"

Failure Output

Status: HTTP/1.1 404 Not Found

  "error": "not_found",
  "error_description": "The item with the id 706 doesn't exist."