Dispatch - Delivery Job Model

jobId *

Deliverect's delivery job ID

string

account *

The unique identifier of the customer account in Deliverect

string

pickupTime *

The expected pick up time in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)

string

transportType

If a transport type has been specified it will appear as one of the values in the list of transport types here.

string

driverTip

The tip amount intended for the courier. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.

integer

ageCheck

Whether an age verification is needed upon delivery

boolean

pickupLocation

Details of the pickup location

object

pickupLocation.location *

The unique identifier of the customer location in Deliverect

string

pickupLocation.name *

name of the location

string

pickupLocation.remarks

specific instructions for pickup at location "ring the bell".

string

pickupLocation.street *

street name

string

pickupLocation.streetNumber *

street number

string

pickupLocation.postalCode *

postal code

string

pickupLocation.city *

city

string

pickupLocation.latitude *

latitude

string

pickupLocation.longitude *

longitude

string

deliveryLocations

Array of delivery locations

array (object)

deliveryLocations.orderId *

Deliverect order ID.

string

deliveryLocations.channelOrderDisplayId * It will not be present on the pre-validation call

Channel order ID. The pre-validation call happens before an order has been placed. In that case, the "channelOrderDisplayId" will be an empty string until order placement is confirmed.

string

deliveryLocations.deliveryTime *

Expected delivery time in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)

string

deliveryLocations.packageSize

Package size if specified from the list here (not provided for all channel orders)

string

deliveryLocations.orderDescription

Details specific to the order

string

deliveryLocations.company

company

string

deliveryLocations.name

customer name

string

deliveryLocations.street *

street

string

deliveryLocations.postalCode *

postal/zip code

string

deliveryLocations.city *

city

string

deliveryLocations.phone

phone

string

deliveryLocations.phoneAccessCode

PhoneAccessCode if available from channel, field will be present only if value is not None.

string

deliveryLocations.latitude *

latitude

string

deliveryLocations.longitude *

longitude

string

deliveryLocations.deliveryRemarks

Details specific to the delivery job

string

deliveryLocations.payment

The total payment amount for the order

object

deliveryLocations.payment.orderIsAlreadyPaid *

Indicates if order has been paid already.

boolean

deliveryLocations.payment.amount *

Amount paid by the end customer for the order. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.

integer

deliveryLocations.payment.paymentType *

Payment type. See the list of payment types here.

integer