Get Rates for Shipment [STREAM]

Fetch available shipping rates for a shipment via stream endpoint.

/rates/stream

GET https://api.terminal.africa/v1/rates/shipment/stream

This endpoint allows you to retrieve rates for a shipment via a stream for improved performance. For more information on streaming apis, see here. This endpoint can be used for single or multi-piece shipments.

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.

Rate streaming response handling works a bit differently from your standard rates api, for an example of how to fetch rates using this api please see

Query Parameters

Name	Type	Description
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.
pickup_address	string	Unique id for pickup address. Required if shipment_id not provided.
delivery_address	string	Unique id for delivery address. Required if shipment_id not provided.
shipment_id	string	Unique id of shipment. Required if delivery_address and pickup_address not provided.
parcel_id	string	Unique id of parcel. Not required if shipment id is provided.
parcel_ids	string	Unique list of parcel ids. Not required if shipment id is provided.
cash_on_delivery	boolean	Set to true to return rates for carriers who supports cash-on-delivery

Headers

Name	Type	Description
Authorization*	string	Set value to Bearer SECRET_KEY

200 Start Event

{
    "type": "start",
    "carriers": [
        "gokada",
        "store-pickup",
        "kwik",
        "ups",
        "ship-to-naija",
        "topship",
        "darum",
        "gigl",
        "get-messenger",
        "dhl-ng",
        "sendstack",
        "dellyman",
        "redstar",
        "qc-express",
        "fez-delivery"
    ]
}

200 Carrier Event

200 Completed Event