Terminal Shipping API
Ask or search…
K

Create Quick Shipment

Create a quick shipment. Pass all required details, including address and parcel in a single API call.
post
https://api.terminal.africa
/v1/shipments/quick
/shipments/quick
This endpoint allows you to create a shipment.
Parameters
Header
Authorization*
string
Set value to Bearer SECRET_KEY
Content-Type*
string
Set value to application/json
Body
pickup_address**
object
Pickup address details for shipment. Refer to Address Object to see attributes required for pickup_address.
delivery_address*
object
Delivery address details for shipment. Refer to Address Object to see attributes required for delivery_address.
parcel
object
Parcel details for shipment. Refer to Parcel Object to see attributes required for delivery_address. Required if parcels is not included
parcels
Array
Array of Parcel Object. Required if parcel is not included
metadata
string
Provide additional context for a shipment.
shipment_purpose
string
Purpose of shipment. Options are commercial, personal, sample, return-after-repair, return-for-repair.
shipment_type
string
Type of shipment to be created. Options are cash-on-delivery. Required if shipment is to be specified as cash-on-delivery
Responses
200
Shipment created successfully.