Sign in

v1

latestOpenAPI 3.0.02026-08-04380104.3 KB
Relay Delivery

Create Delivery

Initiate a new relay delivery using a fee ID from the Get Delivery Fee endpoint.

post/relay/delivery

Request body

fee_idinteger required

ID of the fee returned from the previous step

item_typestring required
user_action'sending' | 'receiving' required

Use "sending" when the source contact is the one making this request or "receiving" when the destination contact is the one making this request

referencestring

Unique reference to identify the delivery, if reference is not provided, we will automatically generate one

estimated_order_amountinteger
customer_delivery_notestring

Leave a note for the delivery person e.g handle with care

Response

200

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Delivery created successfully",
  "data": {
    "reference": "uxj6ztfjt2sstxwiap69",
    "id": 3122,
    "delivery_price": 210000,
    "status": "preparing",
    "made_payment": true
  }
}