Warehouses

1 API call in this section.

List Warehouses

External & Carrier Integrations / Warehouses

GET/external/warehouses?tenant_id={{tenant_id}}

List tenant warehouses with filtering and pagination. Required (query): tenant_id Optional (query): page, limit, status, code, search, total_capacity_order (asc|desc), available_capacity_order (asc|desc), customer_id. Responses: 200 success; 403 insufficient_permissions; 404 tenant_not_found; 500 internal_server_error.

Send a bearer token in Authorization and a tenant API key when the integration requires X-APIKey or X-API-Key.

Request

curl

1curl --request GET "$ONDI_BASE_URL/external/warehouses?tenant_id={{tenant_id}}" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "X-API-Key: {{api_key}}"

Query parameters

tenant_idOptional

query string

{{tenant_id}}

ID of the tenant (Required)

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

X-API-KeyOptional

header string

{{api_key}}

Responses

Success Response200OK

Response body

json

1{2  "success": true,3  "message": "warehouses_retrieved_successfully",4  "warehouses": [5    {6      "id": "wh-uuid",7      "name": "Main WH",8      "code": "WH-001",9      "address": {10        "id": "addr",11        "full_address": "..."12      }13    }14  ],15  "page": 1,16  "limit": 10,17  "total": 118}

Error - Missing tenant_id404Not Found

Response body

json

1{2  "success": false,3  "message": "tenant_not_found"4}

Error - Insufficient Permissions403Forbidden

Response body

json

1{2  "success": false,3  "message": "insufficient_permissions"4}

Error - Server Error500Internal Server Error

Response body

json

1{2  "success": false,3  "message": "internal_server_error"4}