API Documentation
Inventory ItemsView Inventory Item
Method: /items/[id].[format]
Syntax:
https://[subdomain].salesbinder.com/api/2.0/items/[id].json
HTTP Request Type: GETSample Returned JSON Data
1{
2 "item": {
3 "name": "Motivate Pant",
4 "quantity": 42,
5 "threshold": 4,
6 "cost": 80,
7 "price": 98,
8 "description": "Sample description for this item.",
9 "sku": "83775",
10 "serial_number": "",
11 "item_number": 507,
12 "barcode": "948748597",
13 "published": true,
14 "id": "54d7e076-96fc-4937-9eb8-0db0a2d10228",
15 "category_id": "54f60687-c5fc-4182-bd7d-0dd26882ca98",
16 "modified": "2016-11-09T21:34:43+00:00",
17 "created": "2015-02-08T22:17:26+00:00",
18 "suppliers": [
19 {
20 "name": "Lulu Importers",
21 "customer_number": 545,
22 "id": "54ac6027-d7e0-4a87-91a8-03dba2d10228",
23 "_joinData": {
24 "id": "58239673-bc60-4de7-a6d4-405c6882ca98",
25 "customer_id": "54ac6027-d7e0-4a87-91a8-03dba2d10228",
26 "item_id": "54d7e076-96fc-4937-9eb8-0db0a2d10228"
27 }
28 }
29 ],
30 "unit_of_measure": {
31 "id": "4dd3e070-5c03-11e1-b47b-4040248327e7",
32 "full_name": "Items",
33 "short_name": "item(s)"
34 },
35 "images": [
36 {
37 "id": "54d7e071-e96c-47a5-91a8-0d72a2d10228",
38 "filename": "54d7e071-8e8c-43c1-98c3-0d72a2d10228.png",
39 "weight": null,
40 "url_small": "https://..truncated../0d72a2d10228_75x100.png",
41 "url_medium": "https://..truncated../0d72a2d10228_400x500.png",
42 "url_original": "https://..truncated../0d72a2d10228.png"
43 }
44 ],
45 "location": null,
46 "item_variations": [
47 {
48 "id": "54e679a7-b304-47e6-99c5-29446882ca98",
49 "item_id": "54d7e076-96fc-4937-9eb8-0db0a2d10228",
50 "quantity": 0,
51 "item_variations_locations": [
52 {
53 "id": 125921,
54 "item_variation_id": "54e679a7-b304-47e6-99c5-29446882ca98",
55 "location_id": "54b6cca7-22ac-4e96-9b7b-03ffa2d10228",
56 "quantity": 8,
57 "threshold": 0
58 },
59 {
60 "id": 125947,
61 "item_variation_id": "54e679a7-b304-47e6-99c5-29446882ca98",
62 "location_id": "54e7b905-be10-4657-b1d8-29446882ca98",
63 "quantity": 0,
64 "threshold": 0
65 },
66 {
67 "id": 125973,
68 "item_variation_id": "54e679a7-b304-47e6-99c5-29446882ca98",
69 "location_id": "54e917c4-440c-4779-91c1-0dd26882ca98",
70 "quantity": 0,
71 "threshold": 0
72 }
73 ]
74 }
75 ],
76 "item_details": [
77 {
78 "id": "54d7e076-b188-4212-b739-0db0a2d10228",
79 "item_id": "54d7e076-96fc-4937-9eb8-0db0a2d10228",
80 "custom_field_id": "54f60687-ff18-4874-9dcc-0dd26882ca98",
81 "value": "Black",
82 "modified": "2016-11-09T21:34:43+00:00",
83 "created": "2015-02-08T22:17:26+00:00",
84 "custom_field": {
85 "name": "Colour",
86 "publish": true
87 }
88 },
89 {
90 "id": "54d7e076-d0bc-469e-97ec-0db0a2d10228",
91 "item_id": "54d7e076-96fc-4937-9eb8-0db0a2d10228",
92 "custom_field_id": "54f60687-7e54-4442-ba20-0dd26882ca98",
93 "value": "Small",
94 "modified": "2016-11-09T21:34:43+00:00",
95 "created": "2015-02-08T22:17:26+00:00",
96 "custom_field": {
97 "name": "Size",
98 "publish": true
99 }
100 }
101 ]
102 }
103}
Sample Returned XML Data
1<?xml version="1.0" encoding="UTF-8" ?>
2<response>
3 <item>
4 <name>Motivate Pant</name>
5 <quantity>42</quantity>
6 <threshold>4</threshold>
7 <cost>80</cost>
8 <price>98</price>
9 <description>Sample description for this item.</description>
10 <sku>83775</sku>
11 <serial_number/>
12 <item_number>507</item_number>
13 <barcode>948748597</barcode>
14 <published>1</published>
15 <id>54d7e076-96fc-4937-9eb8-0db0a2d10228</id>
16 <category_id>54f60687-c5fc-4182-bd7d-0dd26882ca98</category_id>
17 <modified>11/9/16, 9:34 PM</modified>
18 <created>2/8/15, 10:17 PM</created>
19 <suppliers>
20 <name>Lulu Importers</name>
21 <customer_number>545</customer_number>
22 <id>54ac6027-d7e0-4a87-91a8-03dba2d10228</id>
23 <_joinData>
24 <id>58239673-bc60-4de7-a6d4-405c6882ca98</id>
25 <customer_id>54ac6027-d7e0-4a87-91a8-03dba2d10228</customer_id>
26 <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
27 </_joinData>
28 </suppliers>
29 <unit_of_measure>
30 <id>4dd3e070-5c03-11e1-b47b-4040248327e7</id>
31 <full_name>Items</full_name>
32 <short_name>item(s)</short_name>
33 </unit_of_measure>
34 <images>
35 <id>54d7e071-e96c-47a5-91a8-0d72a2d10228</id>
36 <filename>54d7e071-8e8c-43c1-98c3-0d72a2d10228.png</filename>
37 <weight/>
38 <url_small>https://..truncated../0d72a2d10228_75x100.png</url_small>
39 <url_medium>https://..truncated../0d72a2d10228_400x500.png</url_medium>
40 <url_original>https://..truncated../0d72a2d10228.png</url_original>
41 </images>
42 <location/>
43 <item_variations>
44 <id>54e679a7-b304-47e6-99c5-29446882ca98</id>
45 <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
46 <quantity>0</quantity>
47 <item_variations_locations>
48 <id>125921</id>
49 <item_variation_id>54e679a7-b304-47e6-99c5-29446882ca98</item_variation_id>
50 <location_id>54b6cca7-22ac-4e96-9b7b-03ffa2d10228</location_id>
51 <quantity>8</quantity>
52 <threshold>0</threshold>
53 </item_variations_locations>
54 </item_variations>
55 <item_details>
56 <id>54d7e076-b188-4212-b739-0db0a2d10228</id>
57 <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
58 <custom_field_id>54f60687-ff18-4874-9dcc-0dd26882ca98</custom_field_id>
59 <value>Black</value>
60 <modified>11/9/16, 9:34 PM</modified>
61 <created>2/8/15, 10:17 PM</created>
62 <custom_field>
63 <name>Colour</name>
64 <publish>1</publish>
65 </custom_field>
66 </item_details>
67 <item_details>
68 <id>54d7e076-d0bc-469e-97ec-0db0a2d10228</id>
69 <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
70 <custom_field_id>54f60687-7e54-4442-ba20-0dd26882ca98</custom_field_id>
71 <value>Small</value>
72 <modified>11/9/16, 9:34 PM</modified>
73 <created>2/8/15, 10:17 PM</created>
74 <custom_field>
75 <name>Size</name>
76 <publish>1</publish>
77 </custom_field>
78 </item_details>
79 </item>
80</response>
Updated on February 8th, 2022