Shipment Carriers

Get shipment carriers.

get

This endpoint lists available shipment carriers/methods for the shipment mode in your headers.

Carrier options differ by X-Shipment-Mode:

• SFN returns SFN carriers that ship from Nigeria

• STN returns STN carriers that ship to Nigeria

Use this endpoint before purchase so you can:

• display available carrier options to your users,

• enforce carrier limits (max weight and dimensions),

• show estimated delivery window (min_delivery_business_day / max_delivery_business_day).

Most important field:

• slug: this is the value you must send as shipment_method_slug when purchasing a shipment.

Authorizations

AfricaniesAuth

AuthorizationstringRequired

Base64-encoded public_key:private_key value.

Path parameters

idintegerRequired

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

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

Header parameters

X-Shipment-Modestring · enumRequired

Required shipment mode. Use SFN for shipping from Nigeria or STN for shipping to Nigeria.

Example: SFNPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Shipment carriers retrieved successfully

500Error

application/json

get/api/v1/shipment/carriers/{id}

HTTPcURLJavaScriptPython

GET /api/v1/shipment/carriers/{id} HTTP/1.1
Host: api-sandbox.africaniestest.com
Authorization: YOUR_API_KEY
X-Shipment-Mode: SFN
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Shipment carriers retrieved successfully",
  "data": [
    {
      "id": "0310OA",
      "name": "Africanies Air Express",
      "slug": "africanies_air_express_sfn",
      "mode": "sfn",
      "min_weight": "0.5",
      "max_weight": "1000000",
      "max_length": "75",
      "max_width": "75",
      "max_height": "75",
      "min_delivery_business_day": "3",
      "max_delivery_business_day": "5"
    },
    {
      "id": "0310A2",
      "name": "Africanies Air Express (STN)",
      "slug": "africanies_air_express_stn",
      "mode": "stn",
      "min_weight": "0.5",
      "max_weight": "1000000",
      "max_length": "75",
      "max_width": "75",
      "max_height": "75",
      "min_delivery_business_day": "3",
      "max_delivery_business_day": "5"
    }
  ]
}