Glossary - Dispatch Availability
ⓘ Required Data
Please note that all the fields marked with * are required.
| Parameters | Meaning | Type |
|---|---|---|
| channelLinkId * or channelLinkIds | Unique identifier(s) of the channel(s) (merchant store) in Deliverect. e.g. "channelLinkIds": ["61bcc34f657cc48c23eb60d5","61bcc34f657cc48c23eb602a] In order to validate the delivery on multiple pickup locations an array of strings containing channelLinkIds can be used. | string/array of strings |
| pickupTime | Expected time for the order to be picked up from the restaurant. It is required only for future orders. If the value is not provided , current time will be used as pickupTime. Time format is in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601). Required for future orders * | string |
| deliveryLocations | customer or end-user | object |
deliveryLocations.deliveryTime * | Expected time for the delivery of the order (UTC) Time format is in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601). If the deliveryTime is less than 30 minutes from now, Deliverect will assume it is an ASAP order request. | string |
deliveryLocations.street * | This includes the street number where provided e.g. "Stationsstraat 79e" | string |
deliveryLocations.postalCode * | e.g. "3811MH" | string |
deliveryLocations.city * | e.g. "Amersfoort" | string |
deliveryLocations.coordinates* | Object containing longitude and latitude expressed as below; "coordinates": { "longitude": 9.124598503112793, "latitude": 45.50004196166992 } | object |
deliveryLocations.country | e.g. "The Netherlands" | string |
deliveryLocations.streetNumber | If the number has already been included on the "street" field, it should not be repeated here. e.g." 79e" | string |
deliveryLocations.name | Customer name | string |
deliveryLocations.phone | Customer phone | string |
delivery.Locations.packageSize | Please note that not all dispatch providers have the capability to adjust transport according to size requirements; Verify with Deliverect if the dispatch provided to be used supports receiving packageSize. See all sizes here. | string |