API Documentation

Inventory ItemsAdd Inventory Item

Method: /items.[format]

Document 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.json

HTTP Request Type: POST

Example JSON Data to Submit

1{
2   "item": {
3      "name":"My First API Added Item",
4      "description":"Hello world.",
5      "serial_number":"123456",
6      "sku":"ABC123",
7      "multiple":"1",
8      "quantity":"14.00",
9      "threshold":"2",
10      "cost":"1200.00",
11      "price":"1500.00",
12      "category_id":"54f53d13-aa14-48e2-974f-29436882ca98"
13   }
14}

Example XML Data to Submit

1<item>
2  <name>My Second API Added Item</name>
3  <description>Hello world.</description>
4  <serial_number>123456</serial_number>
5  <sku>ABC123</sku>
6  <multiple>1</multiple>
7  <quantity>14.00</quantity>
8  <threshold>2</threshold>
9  <cost>1200.00</cost>
10  <price>1500.00</price>
11  <category_id>54f53d13-aa14-48e2-974f-29436882ca98</category_id>
12</item>

Success:

If you have been successful in saving a new item, the response will return the newly created data object along with a “message” value of “Saved” as seen below.

Example JSON Returned Response

1{
2    "message": "Saved",
3    "item": {
4        "name": "My First API Added Item",
5        "description": "Hello world.",
6        "serial_number": "123456",
7        "sku": "ABC123",
8        "multiple": true,
9        "quantity": 14,
10        "threshold": 2,
11        "cost": 1200,
12        "price": 1500,
13        "category_id": "54f53d13-aa14-48e2-974f-29436882ca98",
14        "account_id": "4d76bc2e-b198-4bd6-95f5-7439b86a92d9",
15        "item_number": 5285,
16        "created": "2016-11-11T00:50:35+00:00",
17        "modified": "2016-11-11T00:50:35+00:00",
18        "id": "8eb67f97-8ec1-4ec5-ae49-87be9dec43b0"
19    }
20}

Updated on February 8th, 2022