GET /admin/api/{api_version}/inventory_levels.json
Retrieves a list of inventory levels.
You must include inventory_item_ids
, location_ids
, or both as filter parameters.
Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
api_version |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
updated_at_min |
String | No |
Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00). |
limit |
String | No |
The maximum number of results to show.(default: 50)(maximum: 250) |
location_ids |
String | No |
A comma-separated list of location IDs. To find the ID of a location, use the Location resource.(maximum: 50) |
inventory_item_ids |
String | No |
A comma-separated list of inventory item IDs.(maximum: 50) |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.