Dispatch - Delivery Job Model

Dispatch - Delivery Job Model

ⓘ Dispatch Data
Please note that all the fields marked with ( * ) will always be present in the order payload and contain data.

Request Parameters

ParametersMeaningType
jobId * Deliverect's delivery job IDstring
account * The unique identifier of the customer account in Deliverectstring
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
transportTypeIf a transport type has been specified it will appear as one of the values in the list of transport types here.string
driverTipThe 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
ageCheckWhether an age verification is needed upon delivery boolean
pickupLocationDetails of the pickup locationobject
pickupLocation.location * The unique identifier of the customer location in Deliverectstring
pickupLocation.name * name of the locationstring
pickupLocation.remarksspecific instructions for pickup at location "ring the bell".string
pickupLocation.street * street namestring
pickupLocation.streetNumber * street numberstring
pickupLocation.postalCode * postal codestring
pickupLocation.city * citystring
pickupLocation.latitude * latitudestring
pickupLocation.longitude * longitudestring
deliveryLocationsArray of delivery locationsarray (object)
deliveryLocations.orderId * Deliverect order ID.string
deliveryLocations.channelOrderDisplayId * It will not be present on the pre-validation callChannel 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.packageSizePackage size if specified from the list here (not provided for all channel orders)string
deliveryLocations.orderDescriptionDetails specific to the orderstring
deliveryLocations.companycompanystring
deliveryLocations.namecustomer namestring
deliveryLocations.street * streetstring
deliveryLocations.postalCode * postal/zip codestring
deliveryLocations.city * citystring
deliveryLocations.phonephonestring
deliveryLocations.phoneAccessCodePhoneAccessCode if available from channel, field will be present only if value is not None.string
deliveryLocations.latitude * latitudestring
deliveryLocations.longitude * longitudestring
deliveryLocations.deliveryRemarksDetails specific to the delivery jobstring
deliveryLocations.paymentThe total payment amount for the orderobject
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

Response Parameters

ParameterMeaningType
jobIdDeliverect delivery job ID.string
canDeliverIndicates if delivery partner able complete delivery job.boolea
distanceIndicates the distance for the delivery in metersinteger
pickupTimeETAEstimated pick up time in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)string
deliveryLocationsarray of objectsobject
deliveryLocations.deliveryIdId of the delivery generated by delivery partner.string
deliveryLocations.orderIdDeliverect order ID.string
deliveryLocations.deliveryTimeETAEstimated delivery up time.string
deliveryLocations.deliveryRemarksDetails specific to the delivery jobstring
priceThis includes values relating to the cost of the delivery jobobject
price.priceDelivery cost. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.integer
price.taxRateThe tax rate for delivery should be send as an integer with 3 decimal digits e.g. 10000 stands for 10.00% (if not applicable send 0).integer
courierIdThis is the unique identifier of the rider.string
externalJobIdJob id in delivery partner system, used when responding to the create delivery job webhookstring
courierThis includes values relating to the courier assigned to the delivery job used when responding to the create delivery job webhookobject
courier.courierIdUnique ID of the courier if availablestring
courier.firstNameCourier first namestring
courier.lastNameCourier last namestring
courier.phoneNumberCourier contact phone numberstring
courier.transportTypeThe mode of transport used by the courier list of types herestring

Transport types

The following transport types are supported by deliverect.

Transport Type NameString Value
UNKNOWNunknown
BICYCLEbicycle
CARGOBIKEcargobike
MOTORBIKEmotorbike
MOTORBIKE XLmotorbikexl
CARcar

Package sizes

📘

Package size support is limited

Not all channels will provide the below variations on package size

The following package sizes are supported by deliverect.

Package Size NameString ValueDimensionsDescription
UNKNOWNunknownunknownunknown
SMALLsmall22 x 42 x 45 cmStandard delivery with a Courier on a bicycle or scooter.
LARGElarge30 x 124 x 80 cmDelivery which will require to be delivered via car
EXTRA LARGEextraLargeLarger than 30 x 124 x 80 cmFor large catering orders with many different trays to be delivered requiring a van

Payment info

Along with delivery location info, we send payment information. This contains if the order is paid for, the amount of payment, and the payment type. See the table below for payment types currently supported by Deliverect.

Payment Type NameInteger Value
Credit card online0
Cash1
On Delivery2
Online3
Credit Card at Door4
PIN at Door5
Voucher at Door6
Cheque7
Ban Contact8
Other9