Terminal Shipping API
Ask or search…
K

Create Shipment

Create a shipment
post
https://api.terminal.africa
/v1/shipments
/shipments
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
address_from*
string
Unique id of pickup address.
address_to*
string
Unique id of delivery address.
address_return
string
Unique id of return address. If not provided, pickup_address is used by default.
metadata
object
Additional information for shipment.
parcel
string
Id of parcel. One of parcel or parcels must be provided.
parcels
Array
List of parcel ids for creating a multi-parcel shipments. One of parcel or parcels must be provided.
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.