Arrange Pickup & Delivery for Shipment
post
https://api.terminal.africa
/v1/shipments/pickup
/shipments/pickup
This api endpoint allows you to arrange pickup for a shipment.
Parameters
Header
Authorization*
String
Set value to
Bearer SECRET_KEYContent-Type
String
Set value to
application/jsonBody
rate_id*
String
Unique reference of selected rate.
shipment_id
String
Unique id of existing draft shipment. If shipment_id is not provided, a new shipment is generated automatically.
purchase_insurance
Boolean
Use this to indicate if insurance coverage should be provided for the shipment.
cash_to_collect
Number
Cash to be collected by riders. Required if rate_id passed is a cash_on_delivery rate
Responses
200
Pickup for shipment arranged successfully.
Last modified 4mo ago