Customise delivery slots
In order to customise delivery datetime by selecting available slots you can use our GET /api/Orders/getDeliveryServiceSlots endpoint.
This endpoint will provide a list of dynamic available delivery slots for the next 14 days in ASC order with available delivery and respective "pickup slots".
- A delivery slot is a time period donated as start/end UTC ISO-8601 JSON timestamps between which the item is delivery to the customer
- The
pickupSlotsproperty is a child array of the available delivery slots (mutually dependent) and donates the time between which the item is collected/picked-up from the store. deliverySlotstimes andpickupSlotstimes are always assigned as pairs and validated as such, you cannot randomly select different periods.
Recommendation
We always recommend to programatically select the last available pickup-slot closest to the delivery.
For example when querying the endpoint a list is returned in the following format:
[
{
"day": "Monday",
"date": "2021-07-05",
"deliverySlots": [
{
"between": {
"start": "16:00",
"end": "18:00"
},
"betweenUTC": {
"start": "2021-07-12T12:00:00.000Z", // scheduledDeliveryStart
"end": "2021-07-12T14:00:00.000Z" // scheduledDeliveryEnd
},
"pickupSlots": [
{
"between": {
"start": "12:00",
"end": "14:00"
},
"betweenUTC": {
"start": "2021-07-12T08:00:00.000Z",
"end": "2021-07-12T10:00:00.000Z"
}
},
{
"between": {
"start": "14:00",
"end": "16:00"
},
"betweenUTC": {
"start": "2021-07-12T10:00:00.000Z", // scheduledPickupStart
"end": "2021-07-12T12:00:00.000Z" // scheduledPickupEnd
}
}
]
},
{
...
}
]
}
]
Querying the endpoint
Note
This is a GET request. So you will have to URL encode and JSON stringify the URL parameters.
request
.get('/api/Orders/getDeliveryServiceSlots')
.set('Authorization', `Bearer ${access_token}`)
.query({
"storeId": "JYS4vreb9",
"deliveryAddress": {
"firstName": "recipient",
"lastName": "Peddler BV",
"house": "12-46",
"address1": "John M. Keynesplein",
"address2": "B-toren, L.0.K.4",
"city": "Amsterdam",
"state": "Noord Holland",
"postCode": "1066 EP",
"country": "NL",
"phone": "+31623754473"
}
})
.end((err, res) => {
const error = res.error || err;
if (error) {
console.log(error);
}
console.log(res);
});
// response 200 OK LIST OF [DELIVERY DATES][DELIVERY SLOTS][PICKUP SLOTS] available
Utilising the deliverySlots times and pickupSlots times when creating OR updating an order
const mockedDeliveryOrder = {
"orderType": "DELIVERY_ORDER", // required order type
"deliveryLineItems": [ // array of line items to be delivered
{
// NOTE on description: its important that courier can quickly identify the package through a packing slip number
"description": "packing_slip_number", // required 20000 characters or less
"deliveryContentsType": "ALCOHOL", // optional (defaults to GOODS)
// CUSTOM provides pre-agreed rate
"deliveryShippingType": "CUSTOM",// optional (defaults to PACKAGE)
// example path slots[0].deliverySlots[0].betweenUTC.start
"scheduledDeliveryStart": "2021-07-12T12:00:00.000Z",
// example path slots[0].deliverySlots[0].betweenUTC.end
"scheduledDeliveryEnd": "2021-07-12T10:00:00.000Z",
// slots[0].deliverySlots[0].pickupSlots[1].betweenUTC.start
"scheduledPickupStart": "2021-07-12T10:00:00.000Z",
// slots[0].deliverySlots[0].pickupSlots[1].betweenUTC.end
"scheduledPickupEnd": "2021-07-12T12:00:00.000Z",
// required the ID of the store you want to book the delivery for
"storeId": "wOwJ1yBjvh", // required
"deliveryAddress": { // required
...
},
"deliveryEmail": "[email protected]", // optional customer email for notifications
"metaData: "your_reference_id" // optional to keep a reference to your local order
}
],
"webhookUri": "https://peddl.free.beeceptor.com" // (recommended) optional custom webhook URI to receive status updates from the order
}
request
.post('https://api-lokl.peddler.com/api/Orders') // endpoint
.set('Authorization', `Bearer ${access_token}`) // header
.send(mockedDeliveryOrder)
.end((err, res) => {
const error = res.error || err;
if (error) {
console.log(error);
}
const deliveryOrderInstance = res.body; // delivery order instance!
console.log(deliveryOrderInstance);
});
Note
- The
deliverySlotstimes andpickupSlotstimes are always assigned as pairs and validated as such, you cannot randomly select different periods. - It is recommended NOT to use
preferredDeliveryDatewhen custom pickup/delivery slots are used. If you do usepreferredDeliveryDateit will be ignored and the custom slots chosen will have preference.
Querying the endpoint with a multiple storeIds
When there are multiple stores in your account you can query the endpoint with a specific storeId to get the available delivery slots for that store. You can use our GET /api/Orders/getDeliveryServiceSlotsByStoreIds endpoint to get the available delivery slots for multiple stores. This endpoint will return an array of delivery slots for each storeId you provide.
Note
This is a GET request. So you will have to URL encode and JSON stringify the URL parameters.
Request with multiple storeIds
Example request with 2 storeIds
request
.get('/api/Orders/getDeliveryServiceSlotsByStoreIds')
.set('Authorization', `Bearer ${access_token}`)
.query({
"storeId": ["JYS4vreb9", "wOwJ1yBjvh"], // array of storeIds]",
"deliveryAddress": {
"firstName": "recipient",
"lastName": "Peddler BV",
"house": "12-46",
"address1": "John M. Keynesplein",
"address2": "B-toren, L.0.K.4",
"city": "Amsterdam",
"state": "Noord Holland",
"postCode": "1066 EP",
"country": "NL",
"phone": "+31623754473"
}
})
.end((err, res) => {
const error = res.error || err;
if (error) {
console.log(error);
}
console.log(res);
});
Response with multiple storeIds
If storeIds provided are correct and delivery slots are available for the provided storeIds, the response will be an object containing storeIds as key with value containing day-wise pickup/delivery slots for each storeId provided in the request.
Example response with delivery slots for 2 storeIds
{
"JYS4vreb9": [
{
"day": "Monday",
"date": "2021-07-05",
"deliverySlots": [
{
"between": {
"start": "16:00",
"end": "18:00"
},
"betweenUTC": {
"start": "2021-07-12T12:00:00.000Z",
"end": "2021-07-12T14:00:00.000Z"
},
"pickupSlots": [
{
"between": {
"start": "12:00",
"end": "14:00"
},
"betweenUTC": {
"start": "2021-07-12T08:00:00.000Z",
"end": "2021-07-12T10:00:00.000Z"
}
},
{
"between": {
"start": "14:00",
"end": "16:00"
},
"betweenUTC": {
"start": "2021-07-12T10:00:00.000Z",
"end": "2021-07-12T12:00:00.000Z"
}
}
]
},
{
...
}
]
}
],
"wOwJ1yBjvh": [
{
"day": "Monday",
"date": "2021-07-05",
"deliverySlots": [
{
"between": {
"start": "16:00",
"end": "18:00"
},
"betweenUTC": {
"start": "2021-07-12T12:00:00.000Z",
"end": "2021-07-12T14:00:00.000Z"
},
"pickupSlots": [
{
"between": {
"start": "12:00",
"end": "14:00"
},
"betweenUTC": {
"start": "2021-07-12T08:00:00.000Z",
"end": "2021-07-12T10:00:00.000Z"
}
},
{
"between": {
"start": "14:00",
"end": "16:00"
},
"betweenUTC": {
"start": "2021-07-12T10:00:00.000Z",
"end": "2021-07-12T12:00:00.000Z"
}
}
]
},
{
...
}
]
}
]
}
Empty response
If the storeId is invalid or no delivery slots are available, you will receive an empty array result for that storeId.
- Empty response when no delivery slots available
No Delivery Slots available
{
"JYS4vreb9": [],
"wOwJ1yBjvh": []
}
- Empty response when storeId is invalid
Invalid storeId
{
"123455": [],
"JYS4vreb9": [
{
"day": "Monday",
"date": "2021-07-05",
"deliverySlots": [
{
"between": {
"start": "16:00",
"end": "18:00"
},
"betweenUTC": {
"start": "2021-07-12T12:00:00.000Z",
"end": "2021-07-12T14:00:00.000Z"
},
"pickupSlots": [
{
"between": {
"start": "12:00",
"end": "14:00"
},
"betweenUTC": {
"start": "2021-07-12T08:00:00.000Z",
"end": "2021-07-12T10:00:00.000Z"
}
},
{
"between": {
"start": "14:00",
"end": "16:00"
},
"betweenUTC": {
"start": "2021-07-12T10:00:00.000Z",
"end": "2021-07-12T12:00:00.000Z"
}
}
]
},
{
...
}
]
}
]
}