API Documentation

Inventory ItemsEdit Inventory Item

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

Fields:

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

Syntax:

https://[subdomain].salesbinder.com/api/2.0/items/[id].json

HTTP Request Type: PUT

Example JSON Data to Submit

1{
2   "item": {
3      "name":"My Renamed API Added Item"
4   }
5}

Example XML Data to Submit

1<item>
2  <name>My Renamed API Added Item</name>
3</item>

Success:

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

1{
2    "message": "Saved",
3    "item": {
4        "id": "8eb67f97-8ec1-4ec5-ae49-87be9dec43b0",
5        "category_id": "54f53d13-aa14-48e2-974f-29436882ca98",
6        "status_id": 0,
7        "location_id": null,
8        "zone_id": null,
9        "unit_of_measure_id": null,
10        "name": "My Renamed API Added Item",
11        "purchase_date": null,
12        "sold_date": null,
13        "description": "Hello world.",
14        "serial_number": "123456",
15        "sku": "ABC123",
16        "barcode": "",
17        "item_number": 5285,
18        "multiple": true,
19        "threshold": 2,
20        "cost": 1200,
21        "price": 1500,
22        "quantity": 14,
23        "weight": 3,
24        "published": true,
25        "archived": false,
26        "modified": "2016-11-11T01:03:39+00:00",
27        "created": "2016-11-11T00:50:35+00:00",
28        "item_variation_count": 0
29    }
30}

Updated on February 8th, 2022