Shipment

Get shipment rates.

post

This endpoint retrieves shipping rates. based on the provided shipment details including sender/receiver information, package dimensions, and items.

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Body

application/json

boxesstring[]Required

Array of package boxes.

Example: ["architecto"]

last_mile_deliverybooleanOptional

optional Enable last mile delivery.

Example: true

pickupbooleanOptional

optional Enable pickup service.

Example: false

is_insuredstring · enumOptionalExample: 0Possible values:

Responses

200Success

text/plain

stringOptionalExample: { "success": true, "status_code": 200, "message": "Shipment rates retrieved successfully", "data": { "name": "Africanies Air Standard", "slug": "africanies_air_basic_sfn", "total_cost": 150.00, "currency": "USD", ... } }

500Error

application/json

post

/api/v1/shipment/rates

HTTPcURLJavaScriptPython

POST /api/v1/shipment/rates HTTP/1.1
Host: api-sandbox.africaniestest.com
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "addresses": [],
  "boxes": [
    "architecto"
  ],
  "units": [],
  "last_mile_delivery": true,
  "pickup": false,
  "is_insured": "0"
}

{
"success": true,
"status_code": 200,
"message": "Shipment rates retrieved successfully",
"data": {
  "name": "Africanies Air Standard",
 "slug": "africanies_air_basic_sfn",
  "total_cost": 150.00,
  "currency": "USD",
  ...
}
}

Purchase shipment.

post

This endpoint purchases a shipment based on the provided shipment details including sender/receiver information, package dimensions, and items.

File Upload Workflow:

1. First, call /api/v1/file/generate to get signed URLs for your files

2. Upload your files directly to S3 using the returned upload_url values

3. Use the returned s3_key values in documents_s3_key or photos_s3_key arrays

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Body

application/json

assigned_datedateRequired

The assigned date for the shipment.

Example: 2024-01-15

boxesstring[]Required

Array of package boxes.

Example: ["architecto"]

typestringOptional

optional Shipment type.

Example: shipment

currencystringRequired

Currency type.

Example: NGN

product_codestringOptional

optional Product code (P or D).

Example: P

is_insuredstringOptional

optional Insurance status (0 or 1).

Example: 1

external_referencestringRequired

External reference identifier.

Example: EXT-REF-12345

shipment_method_slugstringRequired

Shipment method slug.

Example: africanies_air_express_sfn

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Shipment purchased successfully

500Error

application/json

post

/api/v1/shipment/purchase

HTTPcURLJavaScriptPython

POST /api/v1/shipment/purchase HTTP/1.1
Host: api-sandbox.africaniestest.com
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "address": [],
  "assigned_date": "2024-01-15",
  "boxes": [
    "architecto"
  ],
  "units": [],
  "type": "shipment",
  "currency": "NGN",
  "product_code": "P",
  "is_insured": "1",
  "external_reference": "EXT-REF-12345",
  "shipment_method_slug": "africanies_air_express_sfn"
}

{
  "success": true,
  "status_code": 200,
  "message": "Shipment purchased successfully",
  "data": {
    "shipment_id": "SH123456",
    "tracking_number": "TRK789012",
    "status": "processing"
  }
}

Track shipment.

post

This endpoint tracks a shipment using the shipment ID and tracking number.

Path parameters

tracking_numberstringRequired

The tracking number.

Example: TRK789012

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Shipment tracking retrieved successfully

500Error

application/json

post

/api/v1/shipment/track/{tracking_number}

HTTPcURLJavaScriptPython

POST /api/v1/shipment/track/{tracking_number} HTTP/1.1
Host: api-sandbox.africaniestest.com
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Shipment tracking retrieved successfully",
  "data": {
    "shipment_id": "SH123456",
    "tracking_number": "TRK789012",
    "status": "in_transit",
    "location": "Lagos, Nigeria",
    "estimated_delivery": "2024-01-20"
  }
}