Dispatch - Delivery Job Model
ℹ️ Dispatch Data
Please note that all fields marked with * will always be present in the order payload and contain data.
Request Parameters
| Parameters | Meaning | Type |
|---|---|---|
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
| An order identifier supplied by the channel platform. During pre-validation this will be an empty string until job assignment 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 |
Response Parameters
| Parameter | Meaning | Type |
|---|---|---|
jobId | Deliverect delivery job ID. | string |
canDeliver | Indicates if delivery partner able complete delivery job. | boolean |
distance | Indicates the distance for the delivery in meters | integer |
pickupTimeETA | Estimated pick up time in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601) | string |
| deliveryLocations | array of objects | object |
deliveryLocations.deliveryId | Id of the delivery generated by delivery partner. | string |
deliveryLocations.orderId | Deliverect order ID. | string |
deliveryLocations.deliveryTimeETA | Estimated delivery up time. | string |
deliveryLocations.deliveryRemarks | Details specific to the delivery job | string |
| price | This includes values relating to the cost of the delivery job | object |
price.price | Delivery cost. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100. | integer |
price.taxRate | The 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 |
courierId | This is the unique identifier of the rider. | string |
externalJobId | Job id in delivery partner system, used when responding to the create delivery job webhook It's possible multiple orders could be be delivered as part of one delivery job, setting one externalJobId along with multiple jobs each with unique deliveryId would then be possible Multiple orders aren't currently processes, so an ** externalJobId** can be set with the same value as the deliveryId | string |
| courier | This includes values relating to the courier assigned to the delivery job used when responding to the create delivery job webhook | object |
courier.courierId | Unique ID of the courier if available | string |
courier.firstName | Courier first name | string |
courier.lastName | Courier last name | string |
courier.phoneNumber | Courier contact phone number | string |
courier.transportType | The mode of transport used by the courier list of types here | string |
Transport types
The following transport types are supported by deliverect.
| Transport Type Name | String Value |
|---|---|
| UNKNOWN | unknown |
| BICYCLE | bicycle |
| CARGOBIKE | cargobike |
| MOTORBIKE | motorbike |
| MOTORBIKE XL | motorbikexl |
| CAR | car |
Package sizes
The following package sizes are supported by Deliverect;
⚠️ Package Size Support Is Limited
Not all channels support the package size variations listed below.
| Package Size Name | String Value | Dimensions | Description |
|---|---|---|---|
| UNKNOWN | unknown | unknown | unknown |
| SMALL | small | 22 x 42 x 45 cm | Standard delivery with a Courier on a bicycle or scooter. |
| LARGE | large | 30 x 124 x 80 cm | Delivery which will require to be delivered via car |
| EXTRA LARGE | extraLarge | Larger than 30 x 124 x 80 cm | For 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 Name | Integer Value |
|---|---|
| Credit card online | 0 |
| Cash | 1 |
| On Delivery | 2 |
| Online | 3 |
| Credit Card at Door | 4 |
| PIN at Door | 5 |
| Voucher at Door | 6 |
| Cheque | 7 |
| Ban Contact | 8 |
| Other | 9 |