1. Home
  2. API v2.0
  3. Inventory Items
  4. Edit Inventory Item

Edit Inventory Item

Method: /items/[id].[format]


Name Data Type Description
name String Item Name
description String Optional description of item
serial_number String Item Serial Number (for unique items)
SKU String Stock Keeping Unit
multiple Integer 0 = Unique Item, 1 = Quantity Item
threshold Integer Low Quantity Threshold
cost Decimal Item/Unit Cost
price Decimal Selling price of item/unit
quantity Integer Items in stock (unique items should have 1)
location_id String Location ID
category_id String Category ID
unit_of_measure_id String Unit of Measure ID

Permissions Required:

  • Modify Inventory



HTTP Request Type: PUT

Example JSON Data to Submit

   "item": {
      "name":"My Renamed API Added Item"


If you have been successful in updating an item, the response will return the updated data object along with a “message” value of “Saved” as seen below.

Example JSON Returned Response

    "message": "Saved",
    "item": {
        "id": "8eb67f97-8ec1-4ec5-ae49-87be9dec43b0",
        "category_id": "54f53d13-aa14-48e2-974f-29436882ca98",
        "status_id": 0,
        "location_id": null,
        "zone_id": null,
        "unit_of_measure_id": null,
        "name": "My Renamed API Added Item",
        "purchase_date": null,
        "sold_date": null,
        "description": "Hello world.",
        "serial_number": "123456",
        "sku": "ABC123",
        "barcode": "",
        "item_number": 5285,
        "multiple": true,
        "threshold": 2,
        "cost": 1200,
        "price": 1500,
        "quantity": 14,
        "weight": 3,
        "published": true,
        "archived": false,
        "modified": "2016-11-11T01:03:39+00:00",
        "created": "2016-11-11T00:50:35+00:00",
        "item_variation_count": 0

Example XML Data to Submit

  My Renamed API Added Item

Was this article helpful to you? Yes No