The Containers API allows you to retrieve container information such as status, location, and history. To use this API, you must provide a valid API key. The server automatically determines the originating IP address to ensure it is authorized.
All requests to the API must include:
X-Api-Key header.If authentication fails, the API will return an error message with details.
Endpoint: GET /containers/status
Description: Retrieves the status of a specific container.
Query Parameters:
ContainerNo (string, required): The container number to query.BLNo (string, optional): The Bill of Lading number.DateFrom (string, optional): Start date for the query (format: YYYY-MM-DD).DateTo (string, optional): End date for the query (format: YYYY-MM-DD).ContainerType (string, optional): The type of the container.Status (string, optional): The status of the container.Size (string, optional): The size of the container.Sample Request:
GET /containers/status?ContainerNo=ABCU1234567
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
[
{
"ContainerNo": "ABCU1234567",
"InDate": "2024-11-23T14:45:00",
"BLNo": "",
"Status": "E",
"Size": "20FT",
"Category": "Empty",
"Seal": "",
"Remark": "",
"Left": true,
"OutDate": "2025-01-16T17:54:01.043",
"Consignee": "ABC Limted",
"Line": "MAIN",
"ContType": "Flat-Rack",
"POD": "",
"CarrierType": "T",
"POL": "",
"Notify": "",
"Weight": 0,
"Vessel": "",
"Voyage": "",
"Location": "",
"Facility": "One",
"Comment": "",
"UniqueID": 1234,
"Held": false,
"Heldby": "",
"IsLatestContainerInfo": false
}
]
Endpoint: GET /containers/location
Description: Retrieves the current location of a container.
Query Parameters:
ContainerNo (string, required): The container number to query.BLNo (string, optional): The Bill of Lading number.DateFrom (string, optional): Start date for the query (format: YYYY-MM-DD).DateTo (string, optional): End date for the query (format: YYYY-MM-DD).ContainerType (string, optional): The type of the container.Status (string, optional): The status of the container.Size (string, optional): The size of the container.Sample Request:
GET /containers/location?ContainerNo=ABCU1234567
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
[
{
"ContainerNo": "ABCU1234567",
"BLNo": "",
"CurrentLocation": "ABJ-A2341"
}
]
Endpoint: GET /containers/history
Description: Retrieves the movement history of a container.
Query Parameters:
ContainerNo (string, required): The container number to query.DateFrom (string, optional): Start date for the query (format: YYYY-MM-DD).DateTo (string, optional): End date for the query (format: YYYY-MM-DD).Status (string, optional): The status of the container.Sample Request:
GET /containers/history?ContainerNo=ABCU1234567
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
[
{
"ContainerNo": "ABCU1234567",
"BLNo": "",
"Size": "20FT",
"Status": "Empty",
"Category": "Empty",
"InDate": "2024-11-23T14:45:00",
"LeftDate": "2025-01-16T17:54:01.043",
"Line": "CMA",
"Client": "CMA",
"Consignee": "ABC LIMITED",
"Remark": " "
},
{
"ContainerNo": "ABCU1234567",
"BLNo": "",
"Size": "20FT",
"Status": "Empty",
"Category": "Empty",
"InDate": "2024-10-23T14:45:00",
"LeftDate": "2024-10-25T17:54:01.043",
"Line": "CMA",
"Client": "CMA",
"Consignee": "ABC LIMITED",
"Remark": " "
}
]
Endpoint: GET /containers/rating
Description: Retrieves the raiting history/status of a BL.
Query Parameters:
BLNo (string, required): The Bill Of Laden of the transactionSample Request:
GET /containers/rating?BLNo=ABC1234567
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
[
{
"RatingID": 25023,
"Line": "CMA",
"BLNo": "ABC1234567",
"ProcessDate": "2025-01-06T12:27:22.943",
"BilledTo": "2025-01-09T00:00:00",
"InvoiceNo": "CMA/TSL/0125/16439",
"Currency": "NGN",
"InvoiceValue": 497237.5,
"Status": "Paid",
"AmountPaid": 497237.5,
"RecieptNo": "32227",
"Customer": "TECH SQUID LIMITED",
"UniqueID": 55904
},
{
"RatingID": 26311,
"Line": "CMA",
"BLNo": "ABC1234567",
"ProcessDate": "2025-01-29T10:21:19.53",
"BilledTo": "2025-01-29T00:00:00",
"InvoiceNo": "CMA/TSL/0125/17419",
"Currency": "NGN",
"InvoiceValue": 752550,
"Status": "Paid",
"AmountPaid": 752550,
"RecieptNo": "32852",
"Customer": "TECH SQUID LIMITED",
"UniqueID": 57268
}
]
Endpoint: GET /containers/payments
Description: Retrieves payments history/status of a BL.
Query Parameters:
BLNo (string, required): The Bill Of Laden of the transactionSample Request:
GET /containers/payments?BLNo=ABC1234567
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
[
{
"BLNo": "NAM7164812",
"InvoiceNo": "CMA/TSL/0125/17419",
"Customer": "TECH SQUID LIMITED",
"Currency": "NGN",
"InvoiceValue": 752550,
"AmountPaid": 752550,
"RecieptNo": "32852",
"PayeeName": "TECH SQUID LIMITED",
"PaymentDate": "2025-01-29T00:00:00",
"RefNumber": "NIP FRM OGUH OKECHUKWU-CMATSL012517419NAM7164",
"Validity": "2025-01-29T00:00:00",
"Confirmed": false,
"RecordID": 32852
},
{
"BLNo": "NAM7164812",
"InvoiceNo": "CMA/TSL/0125/16439",
"Customer": "TECH SQUID LIMITED",
"Currency": "NGN",
"InvoiceValue": 497237.5,
"AmountPaid": 497237.5,
"RecieptNo": "32227",
"PayeeName": "TECH SQUID LIMITED",
"PaymentDate": "2025-01-15T00:00:00",
"RefNumber": "NIP FRM OGUH OKECHUKWU-CAMTSL012516439NAM7164",
"Validity": "2025-01-09T00:00:00",
"Confirmed": false,
"RecordID": 32227
}
]
Endpoint: GET /containers/allmajorinfo
Description: Retrieves all major information a specific BL.
Query Parameters:
BLNo (string, optional): The Bill of Lading number.Sample Request:
GET /containers/status?BLNo=AAA324422
Host: api.example.com
X-Api-Key: your_api_key_here
Sample Response:
{
"status": [
{
"ContainerNo": "TXGU6923908",
"InDate": "2025-02-20T00:00:00",
"BLNo": "IBC1290137",
"Status": "Full",
"Size": "40FT",
"Category": "Import",
"Seal": "NA",
"Remark": "",
"Left": false,
"OutDate": null,
"Consignee": "ABBIDEYSCO VENTURES LTD",
"Line": "",
"ContType": "Standard",
"POD": "",
"CarrierType": "Barge",
"POL": "ESSCT",
"Notify": "",
"Weight": 0,
"Vessel": "CMA CGM PUGET_6",
"Voyage": "0BVLWN1MA",
"Location": "",
"Facility": "IBS",
"Comment": "",
"UniqueID": 396101,
"Held": false,
"Heldby": "",
"IsLatestContainerInfo": false
}
],
"ratings": [
{
"RatingID": 27906,
"Line": "CMA",
"BLNo": "IBC1290137",
"ProcessDate": "2025-02-24T12:20:03.657",
"BilledTo": "2025-02-26T00:00:00",
"InvoiceNo": "CMA/AVL/0225/18778",
"Currency": "NGN",
"InvoiceValue": 376300,
"Status": "Paid",
"AmountPaid": 376300,
"RecieptNo": "34198",
"Customer": "ABBIDEYSCO VENTURES LTD",
"UniqueID": 58973
},
{
"RatingID": 28181,
"Line": "CMA",
"BLNo": "IBC1290137",
"ProcessDate": "2025-02-28T17:36:26.877",
"BilledTo": "2025-02-28T00:00:00",
"InvoiceNo": "CMA/AVL/0225/19033",
"Currency": "NGN",
"InvoiceValue": 51112.5,
"Status": "Unpaid",
"AmountPaid": 0,
"RecieptNo": "",
"Customer": "ABBIDEYSCO VENTURES LTD",
"UniqueID": 59294
}
],
"payments": [
{
"BLNo": "IBC1290137",
"InvoiceNo": "CMA/AVL/0225/18778",
"Customer": "ABBIDEYSCO VENTURES LTD",
"Currency": "NGN",
"InvoiceValue": 376300,
"AmountPaid": 376300,
"RecieptNo": "34198",
"PayeeName": "ABBIDEYSCO VENTURES LTD",
"PaymentDate": "2025-02-24T00:00:00",
"RefNumber": "NIP FRM CHIWUZO MIKE BUNOR-CMAAVL022518778 IB",
"Validity": "2025-02-26T00:00:00",
"Confirmed": false,
"UniqueID": 34198
}
]
}
The API returns error messages in JSON format with a clear description of the issue. Example:
{
"error": "Invalid API key. Please provide a valid key."
}