Create Shipment
Create a shipment
/shipments
POST
https://api.terminal.africa/v1/shipments
This endpoint allows you to create a shipment.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Set value to |
Content-Type* | string | Set value to |
Request Body
Name | Type | Description |
---|---|---|
address_from* | string | Unique id of pickup address. |
address_to* | string | Unique id of delivery address. |
metadata | object | Additional information for shipment. |
parcel | string | Id of parcel. One of parcel or parcels must be provided. |
address_return | string | Unique id of return address. If not provided, pickup_address is used by default. |
shipment_purpose | string | Purpose of shipment. Options are commercial, personal, sample, return-after-repair, return-for-repair. |
parcels | Array | List of parcel ids for creating a multi-parcel shipments. One of parcel or parcels must be provided. |
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 |
Last updated