Warehouses
Stock locations and storage facilities.
Endpoints
GET /obapi/v1/warehouses-- listGET /obapi/v1/warehouses/{id}-- single
Parameters
page, per_page, status, sort
Status values
| Value | Description |
|---|---|
open |
Active warehouse |
closed |
Closed warehouse |
Response (list)
{
"items": [
{
"id": "3",
"ref": "WH-MAIN",
"label": "Main warehouse",
"city": "Lyon",
"status": "open"
},
{
"id": "5",
"ref": "WH-PROD",
"label": "Production warehouse",
"city": "Lyon",
"status": "open"
}
],
"pagination": { "..." }
}
Response (single)
{
"warehouse": {
"id": "3",
"ref": "WH-MAIN",
"label": "Main warehouse",
"description": "Central storage facility",
"address": "12 rue de l'Industrie",
"zip": "69003",
"city": "Lyon",
"country": "FR",
"phone": "+33 4 72 00 00 00",
"status": "open",
"parent_warehouse_ref": ""
}
}
Notes
parent_warehouse_refallows hierarchical warehouse structures (e.g. zones within a warehouse).countryuses ISO 3166-1 alpha-2 format.