Back to Aligni.com

Retrieve the list of all inventory locations.

Required permission: Can view inventory.

Examples

# request
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/inventory_location

# Pagination
# The pagination information is included in the response X-Pagination
# header.
# {"total_entries":0,"total_pages":0,"per_page":25,"current_page":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null,"out_of_range":true}
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/inventory_location?page=1&per_page=25

# response
<?xml version="1.0" encoding="UTF-8"?>
<inventory_locations>
  <inventory_location>
    <id>1</id>
    <name>Headquarters</name>
    <shortname>CDHQ</shortname>
    <timezone>Pacific Time (US & Canada)</timezone>
    <description>Consolidated Diversified Headquarters</description>
    <phone1>908.687.5309</phone1>
    <phone2></phone2>
    <address1>123 Pollo del Mar</address1>
    <address2></address2>
    <city>Peoria</city>
    <state>IL</state>
    <postcode>61605</postcode>
    <country>USA</country>
    <created_on>2006-03-09 18:57:37 -0800</created_on>
    <updated_on>2006-03-09 18:58:56 -0800</updated_on>
  </inventory_location>
  ...
</inventory_locations>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
page
optional

Fetch requested page.


Value: Must be a Integer
per_page
optional

Fetch a specific number of entries per page.


Value: Must be a Integer