Skip to main content

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, offsetNeeded info.

2. Endpoints

DocEndpoint
List warehousesGET /api/v6.1/warehouses
Warehouse detailGET /api/v6.1/warehouse
Inventory reportsGET /api/v6.1/inventory_reports, GET /api/v6.1/inventory_reports/by_warehouse
Inventory cardsGET /api/v6.1/inventory_cards
Inbound sheetsGET /api/v6.1/inventory_sheet_ins, GET /api/v6.1/inventory_sheet_in
Outbound sheetsGET /api/v6.1/inventory_sheet_outs, GET /api/v6.1/inventory_sheet_out
Transfer sheetsGET /api/v6.1/inventory_sheet_transfers, GET /api/v6.1/inventory_sheet_transfer
Slip / stocktake sheetsGET /api/v6.1/inventory_sheet_slips, GET /api/v6.1/inventory_sheet_slip

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_id and warehouse_code; missing one of the required identifiers for warehouse or slip detail; fields requests a field not allowed on the public API).
  • 404 — warehouse or slip not found for the given id or code.