Create draft order

post

https://api.kosmo.delivery/v2/orders/draft

You can use this endpoint to create draft order which you can manage later on the Plan Orders platform page. Not supported in Test mode.

Body Params

Create draft order body

pickup

object

The pickup point of origin for the delivery order.

dropoff

object

required

The drop off information for the delivery order.

parcel

object

Deprecated - use parcels instead.

parcels

array of objects

The parcels of the delivery order.

parcels

orderReferenceId

string

Your reference for the order, e.g. order number.

cashOnDeliveryAmount

integer

The amount of cash on delivery in cents. It's required to be greater than 0 if you want to collect cash on delivery.

clientId

string

The client ID. You can manage your clients in the Kosmo dashboard.

201Created