Warehouse (read-only APIs)
1. Overview
Read-only GET APIs: warehouse list/detail, inventory reports, inbound/outbound/transfer/slip sheets, inventory cards.
- Auth:
X-API-KEY - Prefix:
/api/v6.1/ - Common query:
fields,filtering,search,sort,direction,limit,offset— Needed info.
2. Endpoints
| Doc | Endpoint |
|---|---|
| List warehouses | GET /api/v6.1/warehouses |
| Warehouse detail | GET /api/v6.1/warehouse |
| Inventory reports | GET /api/v6.1/inventory_reports, GET /api/v6.1/inventory_reports/by_warehouse |
| Inventory cards | GET /api/v6.1/inventory_cards |
| Inbound sheets | GET /api/v6.1/inventory_sheet_ins, GET /api/v6.1/inventory_sheet_in |
| Outbound sheets | GET /api/v6.1/inventory_sheet_outs, GET /api/v6.1/inventory_sheet_out |
| Transfer sheets | GET /api/v6.1/inventory_sheet_transfers, GET /api/v6.1/inventory_sheet_transfer |
| Slip / stocktake sheets | GET /api/v6.1/inventory_sheet_slips, GET /api/v6.1/inventory_sheet_slip |
3. Related
- Product stock: Product inventory
- Webhooks: Inventory webhooks
- v6.0 (sheet detail uses path
{id}): Warehouse v6.0
4. HTTP status & common errors
- Shared HTTP codes for all APIs: Errors.
- 401 — missing or invalid
X-API-KEY. - 400 — invalid parameters (for example v6.1 sends both
warehouse_idandwarehouse_code; missing one of the required identifiers for warehouse or slip detail;fieldsrequests a field not allowed on the public API). - 404 — warehouse or slip not found for the given id or code.
📄️ List warehouses
1. API overview
📄️ Warehouse detail
1. API overview
📄️ Inventory reports
Product stock at a point in time (or scoped to one warehouse). Domain: InventoryReport.
📄️ Inbound warehouse sheets
Domain InventorySheetIn — read-only (GET).
📄️ Outbound warehouse sheets
Domain InventorySheetOut — read-only (GET).
📄️ Inter-warehouse transfer sheets
Domain InventorySheetTransfer — read-only (GET).
📄️ Stocktake / opening slips
Domain InventorySheetSlip — read-only (GET).
📄️ Inventory cards
Stock movements for a product over a period. Domain: InventoryCard.