List orders

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

You can use this endpoint to get a list of orders.

Responses

Response body

object

orders

array of objects

required

The list of orders

orders*

object

string

required

This is the Kosmo order id.

deliveryId

string

This represents the delivery id provided by the delivery provider.

status

string

This represents the order status. Read more about order statuses under the "List Deliveries" section.

submitted created to_pickup picked_up delivered failed cancelled returning returned at_hub to_dropoff

quoteId

string

The quote used to create the order for reference.

pickupStartEta

string

Estimated time of pick up provided in RFC3339. This is the earliest time the order can be picked up. Can be empty.

pickupEta

string

Estimated time of pick up provided in RFC3339. This is the latest time the order can be picked up. Can be empty.

dropoffEta

string

The estimated time of arrival for the dropoff.

autoReassign

boolean

If automatic reassignment was enabled.

trackingURL

string

URL to track the order.

vehicleType

string

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

motorcycle car van lorry

deliveryType

string

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

ASAP 2H 4H NEXT_DAY NEXT_3_DAYS

services

array of objects

What services 3PL providers will have for your order.

services

object

string

required

The name of the service.

proofDelivery insurance door2door cashOnDelivery

merchantId

string

This represents the merchant which we placed the order for.

driver

object

pickup

object

required

The pick up point of origin for the delivery order.

dropoffs

array of objects

required

The list of dropoffs.

dropoffs*

object

location

object

required

Details of location.

receiver

object

required

Details of contact (can be a store or a person).

parcels

array of objects

The list of parcels.

parcels

object

description

string

Description of the parcel.

weight

number

Weight of the parcel in kilograms.

height

integer

Height of the parcel in centimeters.

width

integer

Width of the parcel in centimeters.

quantity

integer

Number of parcels.

length

integer

Length of the parcel in centimeters.

value

object

Value of the parcel in cents

reference

string

Internal reference for parcel if any.

handlingInstructions

object

Specify any particular instructions you want the driver to be aware of when handling the parcel.

waybillURL

string

URL link to the waybills for printing. Each unique parcel will require one unique waybill label.

orderReferenceId

string

You can provide this field to identify this dropoff with a specific ID in your system. So you will be able to track your system order in a case if you want to create multi dropoff order.

proofOfDeliveryURL

string

Deprecated - use proofs instead. The URL of the proof of delivery image.

proofs

array of strings

The list of proofs of dropoff. Lasts for 7 days.

proofs

trackingURL

string

Tracking URL with complete information such as payment and all recipients.

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.

deliveryFee

integer

The client base delivery fee in cents.

tips

integer

The client tips in cents.

clientId

string

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

failureReason

string

Failure reason if any.

incorrect_missing_item deliver_another_time destination_unreachable recipient_unavailable unable_to_find_customer other

failureReasonNote

string

The note of the failure reason if any.

status

string

The status of the dropoff.

delivered canceled to_dropoff returning returned

noteFromDriver

string

The note from the driver if any.

200OK

400Bad Request

403Forbidden

500Internal Server Error