1. Home
  2. API v2.0
  3. Inventory Items
  4. List & Search Inventory Items

List & Search Inventory Items

Method: /items.[format]

Parameters: (optional)

Param Name: Description:
page Which page to retrieve from paginated results (numeric)
pageLimit How many records per result set (numeric between 1 – 200)
categoryId Filter items by categoryId (36 char string)
locationId Filter items by locationId (36 char string)
itemIdNumber Get data for specific item by itemIdNumber (numeric)
orderField Sort result set by specific field
orderDirection Sort result set “asc” or “desc”
modifiedSince Return anything modified since timestamp (epoch timestamp)
s Search parameter
field Search a specific data field (name, sku, serial_number, item_number, barcode)
exact Only return exact matches in your search results (true or blank)
compact Reduces returned results’ object nested depth (true or blank)

Syntax

https://[subdomain].salesbinder.com/api/2.0/items.json?page=[number]&categoryId=[category_id]&locationId=[location_id]&modifiedSince=[unix_timestamp]&pageLimit[int]

HTTP Request Type: GET

Note: The modifiedSince parameter is used for retrieving only the inventory item’s data that has been modified since a specific point in time. This is based on the value of the “modified” field and is useful for doing faster, more efficient syncing. The modifiedSince value must be provided in unix timestamp number format (unix epoch, i.e. 1470429617).

The pageLimit parameter will accept any numeric digit between 1 and 200 which defines how many results you get in each resultset (defaults to 20 per page).

Sample Returned JSON Data

{  
   "count":"2",
   "page":"1",
   "pages":"1",
   "items":[  
      [  
         {  
            "name":"Motivate Pant",
            "quantity":42,
            "threshold":4,
            "cost":80,
            "price":98,
            "description":"",
            "sku":"",
            "serial_number":"",
            "item_number":507,
            "barcode":"",
            "published":true,
            "id":"54d7e076-96fc-4937-9eb8-0db0a2d10228",
            "category_id":"54f60687-c5fc-4182-bd7d-0dd26882ca98",
            "location_id":null,
            "modified":"2016-10-06T17:16:23+00:00",
            "created":"2015-02-08T22:17:26+00:00",
            "unit_of_measure":{  
               "id":"4dd3e070-5c03-11e1-b47b-4040248327e7",
               "full_name":"Items",
               "short_name":"item(s)"
            },
            "item_details":[  
               {  
                  "value":"Blue",
                  "id":"54d7e076-b188-4212-b739-0db0a2d10228",
                  "item_id":"54d7e076-96fc-4937-9eb8-0db0a2d10228",
                  "custom_field_id":"54f60687-ff18-4874-9dcc-0dd26882ca98",
                  "custom_field":{  
                     "name":"Colour",
                     "publish":true
                  }
               },
               {  
                  "value":"Small",
                  "id":"54d7e076-d0bc-469e-97ec-0db0a2d10228",
                  "item_id":"54d7e076-96fc-4937-9eb8-0db0a2d10228",
                  "custom_field_id":"54f60687-7e54-4442-ba20-0dd26882ca98",
                  "custom_field":{  
                     "name":"Size",
                     "publish":true
                  }
               }
            ],
            "location":null,
            "images":[  
               {  
                  "id":"54d7e071-e96c-47a5-91a8-0d72a2d10228",
                  "filename":"54d7e071-8e8c-43c1-98c3-0d72a2d10228.png",
                  "weight":null,
                  "url_small":"https://..truncated../98c3-0d72a2d10228_75x100.png",
                  "url_medium":"https://..truncated../98c3-0d72a2d10228_400x500.png",
                  "url_original":"https://..truncated../98c3-0d72a2d10228.png"
               }
            ]
         },
         {  
            "name":"Essence Tank",
            "quantity":0,
            "threshold":0,
            "cost":40,
            "price":52,
            "description":"",
            "sku":"",
            "serial_number":"",
            "item_number":506,
            "barcode":"",
            "published":true,
            "id":"54d7e004-ae34-4f50-ba90-0db0a2d10228",
            "category_id":"54f60687-c5fc-4182-bd7d-0dd26882ca98",
            "location_id":null,
            "modified":"2015-10-23T20:27:18+00:00",
            "created":"2015-02-08T22:15:32+00:00",
            "unit_of_measure":{  
               "id":"4dd3e070-5c03-11e1-b47b-4040248327e7",
               "full_name":"Items",
               "short_name":"item(s)"
            },
            "item_details":[  
               {  
                  "value":"Medium",
                  "id":"54d7e004-cb4c-4a8b-8f6d-0db0a2d10228",
                  "item_id":"54d7e004-ae34-4f50-ba90-0db0a2d10228",
                  "custom_field_id":"54f60687-7e54-4442-ba20-0dd26882ca98",
                  "custom_field":{  
                     "name":"Size",
                     "publish":true
                  }
               },
               {  
                  "value":"Black",
                  "id":"54d7e004-dd98-4b50-933f-0db0a2d10228",
                  "item_id":"54d7e004-ae34-4f50-ba90-0db0a2d10228",
                  "custom_field_id":"54f60687-ff18-4874-9dcc-0dd26882ca98",
                  "custom_field":{  
                     "name":"Colour",
                     "publish":true
                  }
               }
            ],
            "location":null,
            "images":[  
               {  
                  "id":"54d7e001-bcb4-46d9-8fc5-0d72a2d10228",
                  "filename":"54d7e001-3a60-469c-9859-0d72a2d10228.png",
                  "weight":null,
                  "url_small":"https://..truncated../0d72a2d10228_75x100.png",
                  "url_medium":"https://..truncated../0d72a2d10228_400x500.png",
                  "url_original":"https://..truncated../0d72a2d10228.png"
               }
            ]
         }
      ]
   ]
}

Sample Returned XML Data

<response>
    <item>
        <name>Motivate Pant</name>
        <quantity>42</quantity>
        <threshold>4</threshold>
        <cost>80</cost>
        <price>98</price>
        <description/>
        <sku/>
        <serial_number/>
        <item_number>507</item_number>
        <barcode/>
        <published>1</published>
        <id>54d7e076-96fc-4937-9eb8-0db0a2d10228</id>
        <category_id>54f60687-c5fc-4182-bd7d-0dd26882ca98</category_id>
        <location_id/>
        <modified>10/6/16, 5:16 PM</modified>
        <created>2/8/15, 10:17 PM</created>
        <unit_of_measure>
            <id>4dd3e070-5c03-11e1-b47b-4040248327e7</id>
            <full_name>Items</full_name>
            <short_name>item(s)</short_name>
        </unit_of_measure>
        <item_details>
            <value/>
            <id>54d7e076-b188-4212-b739-0db0a2d10228</id>
            <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
            <custom_field_id>54f60687-ff18-4874-9dcc-0dd26882ca98</custom_field_id>
            <custom_field>
                <name>Colour</name>
                <publish>1</publish>
            </custom_field>
        </item_details>
        <item_details>
            <value/>
            <id>54d7e076-d0bc-469e-97ec-0db0a2d10228</id>
            <item_id>54d7e076-96fc-4937-9eb8-0db0a2d10228</item_id>
            <custom_field_id>54f60687-7e54-4442-ba20-0dd26882ca98</custom_field_id>
            <custom_field>
                <name>Size</name>
                <publish>1</publish>
            </custom_field>
        </item_details>
        <location/>
        <images>
            <id>54d7e071-e96c-47a5-91a8-0d72a2d10228</id>
            <filename>54d7e071-8e8c-43c1-98c3-0d72a2d10228.png</filename>
            <weight/>
            <url_small>https://..truncated../0d72a2d10228_75x100.png</url_small>
            <url_medium>https://..truncated../0d72a2d10228_400x500.png</url_medium>
            <url_original>https://..truncated../0d72a2d10228.png</url_original>
        </images>
    </item>
    <item>
        <name>Essence Tank</name>
        <quantity>0</quantity>
        <threshold>0</threshold>
        <cost>40</cost>
        <price>52</price>
        <description/>
        <sku/>
        <serial_number/>
        <item_number>506</item_number>
        <barcode/>
        <published>1</published>
        <id>54d7e004-ae34-4f50-ba90-0db0a2d10228</id>
        <category_id>54f60687-c5fc-4182-bd7d-0dd26882ca98</category_id>
        <location_id/>
        <modified>10/23/15, 8:27 PM</modified>
        <created>2/8/15, 10:15 PM</created>
        <unit_of_measure>
            <id>4dd3e070-5c03-11e1-b47b-4040248327e7</id>
            <full_name>Items</full_name>
            <short_name>item(s)</short_name>
        </unit_of_measure>
        <item_details>
            <value/>
            <id>54d7e004-cb4c-4a8b-8f6d-0db0a2d10228</id>
            <item_id>54d7e004-ae34-4f50-ba90-0db0a2d10228</item_id>
            <custom_field_id>54f60687-7e54-4442-ba20-0dd26882ca98</custom_field_id>
            <custom_field>
                <name>Size</name>
                <publish>1</publish>
            </custom_field>
        </item_details>
        <item_details>
            <value/>
            <id>54d7e004-dd98-4b50-933f-0db0a2d10228</id>
            <item_id>54d7e004-ae34-4f50-ba90-0db0a2d10228</item_id>
            <custom_field_id>54f60687-ff18-4874-9dcc-0dd26882ca98</custom_field_id>
            <custom_field>
                <name>Colour</name>
                <publish>1</publish>
            </custom_field>
        </item_details>
        <location/>
        <images>
            <id>54d7e001-bcb4-46d9-8fc5-0d72a2d10228</id>
            <filename>54d7e001-3a60-469c-9859-0d72a2d10228.png</filename>
            <weight/>
            <url_small>https://..truncated../0d72a2d10228_75x100.png</url_small>
            <url_medium>https://..truncated../0d72a2d10228_400x500.png</url_medium>
            <url_original>https://..truncated../0d72a2d10228.png</url_original>
        </images>
    </item>
</response>
Was this article helpful to you? Yes No