Terminal Shipping API
Ask or search…
K

Get Rates for Shipment

Fetch available shipping rates for a shipment.
get
https://api.terminal.africa
/v1/rates/shipment
/rates
This endpoint allows you to retrieve rates for a shipment. Must include parcel_id and one of pickup_address & delivery_address or shipment_id. To return cash on delivery rates for carriers who supports cash-on-delivery, set cash_on_delivery to true if shipment_id does not include a shipment_type of cash-on-delivery.
Parameters
Query
currency
string
Currency for rates. Defaults to NGN. Available options are AED, AUD, CAD, CNY, EUR, GBP, GHS, HKD, KES, NGN, TZS, UGX, USD, ZAR.
delivery_address
string
Unique id for delivery address. Required if shipment_id not provided.
pickup_address
string
Unique id for pickup address. Required if shipment_id not provided.
parcel
string
Unique id of parcel. Not required if shipment id is provided.
shipment_id
string
Unique id of shipment. Required if delivery_address and pickup_address not provided.
cash_on_delivery
boolean
Set to true to return rates for carriers who supports cash-on-delivery
Header
Authorization*
string
Set value to Bearer SECRET_KEY
Responses
200
Rates retrieved successfully.