Create quotes

post https://api.kosmo.delivery/v2/quotes

You can use this endpoint to generate quotes from multiple providers.

Body Params

Quote body

priority

string

This will define how your results are prioritized. If the value is time you will get the fastest ETAs in first place. If the value is price you will get the cheapest results in first place. If no value is provided, price will be the priority.

deliveryType

string

The delivery type. It's defined by the pick up and delivery time. Read more explanation under the "Quotes" section.

pickupStartTime

date-time

This represents the earliest time order will be picked up. Actual time the driver arrives at the pick-up timing is dependent on the delivery types (see delivery types). If not provided, the default value is the current time. If time is within 15 minutes it will be ignored.

pickup

object

required

The pickup point of origin for the delivery order.

dropoffs

array of objects

required

length ≤ 20

The drop off point/s to deliver the items. If multiple they can be send as an array(max 20 stops). Use sequence to enforce a position in the route you want. Please leave it empty if you would like us to optimize the route for you.

dropoffs*

vehicleType

string

The vehicle type. You can refer to the table provided under "Quotes" section to determine which vehicle type to choose.

optimizeRoute

boolean

When enabled, we will automatically optimize the route to reduce the distance as much as possible.

proofDelivery

boolean

Optionally you can request proof of delivery for this given order.

door2door

boolean

When enabled, we will show only quotes that are door to door.

rules

object

You can provide rules to filter the quotes and manage an order.

merchantId

string

You can provide merchant id to generate the quotes on behalf of the merchant.

Responses

Language

Credentials

Bearer

token


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.kosmo.delivery/v2/quotes \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

403Forbidden

500Internal Server Error