Terminal Shipping API
Ask or search…
K

Update Shipment

Update information for an existing draft shipment.
put
https://api.terminal.africa/v1
/shipments/:shipment_id
/shipments/:shipment_id
This endpoint allows you to update a draft shipment.
Parameters
Path
shipment_id*
String
Unique reference for the shipment.
Body
address_to
String
Unique id of delivery address.
address_from
String
Pickup address for shipment.
address_return
String
Return address for shipment.
metadata
Object
Provides additional information for a shipment.
parcel
String
Unique identifier of parcel to be shipped.
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.
Responses
200: OK
Shipment updated successfully.