Dispatch - Delivery Job Model
Request Parameters
| Parameters | Meaning | Type |
|---|---|---|
jobId | Deliverect delivery job ID | str |
account | The unique identifier of the customer account in Deliverect | str |
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) | str |
transportType | If a transport type has been specified it will appear as one of the values in the list of types here | str |
driverTip | The tip amount intended for the courier | int |
ageCheck | Whether an age verification is needed upon delivery or not | bool |
| pickupLocation | Details of the pickup location | obj |
pickupLocation.location | The unique identifier of the customer location in Deliverect | str |
pickupLocation.name | name of the location | str |
pickupLocation.remarks | specific instructions for pickup at location "ring | str |
pickupLocation.street | street name | str |
pickupLocation.streetNumber | street number | str |
pickupLocation.postalCode | postal code | str |
pickupLocation.city | city | str |
pickupLocation.latitude | latitude | str |
pickupLocation.longitude | longitude | str |
| deliveryLocations | Array of delivery locations | array (object) |
deliveryLocations.orderId | Deliverect order ID. | str |
deliveryLocations.channelOrderDisplayId | Channel order ID. | str |
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) | str |
deliveryLocations.orderDescription | Details specific to the order | str |
deliveryLocations.company | company | str |
deliveryLocations.name | customer name | str |
deliveryLocations.street | street | str |
deliveryLocations.postalCode | postal/zip code | str |
deliveryLocations.city | city | str |
deliveryLocations.phone | phome | str |
deliveryLocations.phoneAccessCode | PhoneAccessCode if available from channel, field will be present only if value is not None. | str |
deliveryLocations.latitude | latitude | |
deliveryLocations.longitude | longitude | |
deliveryLocations.deliveryRemarks | Details specific to the delivery job | |
| deliveryLocations.payment | The total payment amount for the order | obj |
deliveryLocations.payment.orderIsAlreadyPaid | Indicates if order has been paid already. | bool |
deliveryLocations.payment.amount | Payment amount. | int |
deliveryLocations.payment.paymentType | Payment type. | int |
Response Parameters
| Parameter | Meaning | Type |
|---|---|---|
jobId | Deliverect delivery job ID. | str |
canDeliver | Indicates if delivery partner able complete delivery job. | bool |
distance | Indicates the distance for the delivery | int |
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) | str |
| deliveryLocations | array of objects | obj |
deliveryLocations.deliveryId | Id of the delivery generated by delivery partner. | str |
deliveryLocations.orderId | Deliverect order ID. | str |
deliveryLocations.deliveryTimeETA | Estimated delivery up time. | str |
deliveryLocations.deliveryRemarks | str | |
| price | This includes values relating to the cost of the delivery job | obj |
price.price | Delivery cost (1000 stands for 10.00). | int |
price.taxRate | Tax rate for delivery - 10000 stands for 10.00% (if not applicable send 0) | int |
courierId | This is the unique identifier of the rider. | str |
externalJobId | Job id in delivery partner system, used when responding to the create delivery job webhook | str |
| courier | This includes values relating to the courier assigned to the delivery job used when responding to the create delivery job webhook | obj |
courier.courierId | Unique ID of the courier if available | str |
courier.firstName | Courier first name | str |
courier.lastName | Courier last name | str |
courier.phoneNumber | Courier contact phone number | str |
courier.transportType | The mode of transport used by the courier list of types here | str |
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
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 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 |