get
https://{subdomain}.myshoplaza.com/openapi/2025-06/locations//inventory_levels
List all inventory information of this location .
Requiresread_shop_navigationaccess scope. More access scope
Retrieves paginated inventory level data for a specific location, including stock quantities and update timestamps.
This API is essential for:
- Monitoring real-time stock levels across locations
- Synchronizing inventory data with external systems
- Generating inventory reports and analytics
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
location_id | string | Yes | Unique identifier of the location | "loc_123" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status indicator |
message | string | "Inventory levels retrieved" | Result description |
data.inventory_levels | array[object] | - | Inventory records |
data.inventory_levels.inventory_item_id | string | "item_456" | Unique item identifier |
data.inventory_levels.location_id | string | "loc_123" | Location identifier |
data.inventory_levels.stock | string | "100" | Current stock quantity |
data.inventory_levels.updated_at | string | "2023-01-01T00:00:00Z" | Last update timestamp |
data.cursor | string | "def456" | Pagination token for next page |
data.has_more | boolean | true | More records available |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |