API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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
string

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

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.

string

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

tags
array of strings

Tags for the order.

tags
string
enum

The priority of the stop.

Allowed:
Headers
boolean

Set to true if you want to check if the provided referenceId already exists in the system. If it exists, the system will return an error already_exists.

Responses

Updated almost 2 years ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago