Terminal Shipping API
Ask or search…
K

Get Shipments v2

Fetch a list of all shipments available for a user.
get
https://api.terminal.africa
/v2/shipments
/shipments
This endpoint allows you to get a list of shipments available for a user.
Parameters
Query
perPage
string
Specify how many results will be returned in a single request. Defaults to 50.
page
string
Specify what page of records will be sent in response. Defaults to 1.
status
string
Status of shipment. Must be one of cancelled, confirmed, delivered, draft, in-transit, pending
start_date
Filter from shipment creation start date. Format: YYYY-MM-DD
eg ?start_date=2023-05-01
end_date
Filter from shipment creation end date. Format: YYYY-MM-DD
eg ?end_date=2023-05-01
carrier_id
Filter shipments by carrier_id
eg?carrier_id=CA-81957188177
carrier_slug
Filter shipments by carrier_slug
eg?carrier_slug=dhl
pickup_country
Filter shipment by pickup country
Eg ?pickup_country=NG
delivery_country
Filter shipment by delivery country
Eg ?delivery_country=NG
pickup_state
Filter shipment by pickup state
Eg ?pickup_state=Lagos
delivery_state
Filter shipment by delivery state
Eg ?delivery_state=Lagos
pickup_city
Filter shipment by pickup city
Eg ?pickup_city=Apapa
delivery_city
Filter shipment by delivery city
Eg ?delivery_city=Apapa
search
Search for shipments using text string. The searchable fields includes tracking_number, shipment_id, shipment reference.
Eg: ?search=search_text
orderBy
Order a shipments. Default to DESC created_at (-created_at). Ordering fields includes: created_at, updated_at, pickup_date, delivery_date, amount.
EXAMPLES OF DESC ORDERING
1. ?orderBy=-created_at
2. ?orderBy=-amount
3. ?orderBy=-updated_at
EXAMPLES OF ASC ORDERING
1. ?orderBy=created_at
2. ?orderBy=amount
3. ?orderBy=updated_at
Header
Authorization*
string
Set value to Bearer ACCESS_TOKEN
Responses
200
Shipments retrieved successfully.