API Documentation

LocationsList Locations

Method: /locations.[format]

Permissions Required:

Inventory Management

Syntax:

https://[subdomain].salesbinder.com/api/2.0/locations.json?page=[number]

HTTP Request Type: GET

Sample Returned JSON Data

{
   "count":"4",
   "page":"1",
   "pages":"1",
   "locations":[
      {
         "location":{
            "id":"4f3eedc9-9520-431e-a84a-3975b86a92d9",
            "name":"New Jersey Warehouse 1",
            "short_name":"NJ-1",
            "address_1":"100 Centerton Road",
            "address_2":"",
            "city":"Mount Laurel",
            "region":"New Jersey",
            "postal_code":"08054",
            "country":"USA",
            "phone":null,
            "fax":null,
            "email":null,
            "manager":null,
            "item_count":"1"
         }
      },
      {
         "location":{
            "id":"4efb9bc0-d578-44d9-a95e-7a07b86a92d9",
            "name":"New York Warehouse 1",
            "short_name":"NY-1",
            "address_1":"302A West 12th Street",
            "address_2":"",
            "city":"New York",
            "region":"NY",
            "postal_code":"10014",
            "country":"USA",
            "phone":null,
            "fax":null,
            "email":null,
            "manager":null,
            "item_count":"6"
         }
      }
   ]
}

Sample Returned XML Data

<?xml version="1.0" encoding="UTF-8" ?>
	<count>4</count>
	<page>1</page>
	<pages>1</pages>
	<locations>
		<location>
			<id>4f3eedc9-9520-431e-a84a-3975b86a92d9</id>
			<name>New Jersey Warehouse 1</name>
			<short_name>NJ-1</short_name>
			<address_1>100 Centerton Road</address_1>
			<address_2></address_2>
			<city>Mount Laurel</city>
			<region>New Jersey</region>
			<postal_code>08054</postal_code>
			<country>USA</country>
			<phone />
			<fax />
			<email />
			<manager />
			<item_count>1</item_count>
		</location>
	</locations>
	<locations>
		<location>
			<id>4efb9bc0-d578-44d9-a95e-7a07b86a92d9</id>
			<name>New York Warehouse 1</name>
			<short_name>NY-1</short_name>
			<address_1>302A West 12th Street</address_1>
			<address_2></address_2>
			<city>New York</city>
			<region>NY</region>
			<postal_code>10014</postal_code>
			<country>USA</country>
			<phone />
			<fax />
			<email />
			<manager />
			<item_count>6</item_count>
		</location>
	</locations>

Updated on February 4th, 2022