Warehouse

Get warehouses.

get

This endpoint retrieves warehouses from the parent application.

Path parameters

idintegerRequired

Optional parameter. optional The ID of the specific warehouse to retrieve.

Example: {"summary":"When the value is omitted","value":""}

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Warehouses retrieved successfully

500Error

application/json

get

/api/v1/warehouse/{id}

HTTPcURLJavaScriptPython

GET /api/v1/warehouse/{id} HTTP/1.1
Host: api-sandbox.africaniestest.com
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Warehouses retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Lagos Warehouse",
      "address": "123 Main Street, Lagos",
      "active": true
    }
  ]
}

Get warehouses by country.

get

This endpoint retrieves warehouses filtered by country from the parent application.

Path parameters

countrystringRequired

The country code or name to filter warehouses.

Example: NG

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Warehouses by country retrieved successfully

500Error

application/json

get

/api/v1/warehouse/country/{country}

HTTPcURLJavaScriptPython

GET /api/v1/warehouse/country/{country} HTTP/1.1
Host: api-sandbox.africaniestest.com
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Warehouses by country retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Lagos Warehouse",
      "country": "NG",
      "address": "123 Main Street, Lagos",
      "active": true
    }
  ]
}