store_inventories
Read-only
Retrieve stock levels and cost prices for each offer and warehouse. Use details for a per-store breakdown of inventory.
Instructions
Stock levels (and cost prices) per offer/warehouse. Use details:true for the per-store breakdown. Returns {offers[], pagination}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| site | No | Site (store) symbolic code. Required on create/edit when the API key is scoped to multiple sites (see list_sites). | |
| limit | No | Results per page (max 100) | |
| details | No | Include per-store breakdown (sets filter[details]=1) | |
| filter_product_active | No | Only offers of active products | |
| filter_offer_external_id | No | Filter by offer externalId |