Signals Notebook: How to Retrieve a List of Inventory Location Data in JSON Format via API

To retrieve a list of Inventory Location data via API, use GET /entities.

Example using Swagger: 

1. Sign in with an administrator account and navigate to "App Launcher > Signals Configuration > System Settings > API Key".*1
2. Click "Open External API Document".
3. Expand "Entities".
4. Expand "GET /entities".
5. Click "Try it out".
6. Enter the following query parameters:*2
   • includeTypes:location
   • includeOptions:untrashed,nontemplate
7. Click "Execute".
8. Confirm that the Server response returns 200, then click "Download".*3

Notes:

*1 The locations that can be retrieved are limited to those for which the administrator account used to open Swagger in Step 1 has Read or higher permissions.

*2 The following additional query parameters are also available:

• page[limit]: Specifies the maximum number of items to return per request (default: 20, max: 100). This must be changed if the number of Locations exceeds 20.
• page[offset]: Specifies the number of items to skip before returning results (default: 0). If the total number of locations exceeds 100 and cannot be retrieved in a single request, use page[offset] to retrieve data in multiple requests.

*3 If the links.next field is included in the response body, it is possible that not all data has been retrieved. In that case, adjust the query parameters described in *2 and send the request again.