patch
https://api.staging.deliverect.com/commerce//baskets//fulfillment
Purpose
Modify the fulfilment type and its associated parameters and/or update the requested fulfilment time.
Fulfillment Types:
| Type | Definition |
|---|---|
delivery | Commerce platform will be arranging delivery |
pickup | Will be collected i.e. for takeaway (can apply for Kiosk orders) |
curbside | Will be as per pickup, but specific handoff to customer in vehicle |
eat-in | Customer will be ordering on-premise e.g. QR Code ordering |
dispatch | Distinct from 'Delivery' where Deliverect will be facilitating delivery via an integrated Dispatch partner |
Parameters:
Aside from the "type" being updated, below shows specific parameters expected when updating each fulfillment type. All required attributes are marked with *
Delivery
| Parameter | Meaning | Type |
|---|---|---|
*time | The intended pickup time for the order | string |
address.line | Full address in single line | string |
address.coordinates | Geo-location, expressed as [lat, lon] | array [lat, lon] |
Example Request
{
"type": "delivery",
"time": "2024-01-15T10:00",
"address": {
"line": "Foreestelaan 82, 9000 Gent, Belgium",
"coordinates": [51.03162341734958, 3.7337162550022622]
}
}Pickup
Example Request
{
"type": "pickup",
}Curbside
| Parameter | Meaning | Type |
|---|---|---|
pickupNotes | Special instructions from the customer on their Curbside order e.g. Car moderl/colour/registration | string |
{
"type": "curbside",,
"pickupNotes":"Yellow Honda"
}Eat-In
| Parameter | Meaning | Type |
|---|---|---|
spot | Specific location in the venue e.g. the table number or position at a counter | string |
{
"type": "eatIn",
"spot": "table 2"
}Dispatch
| Parameter | Meaning | Type |
|---|---|---|
address.line | Full address in single line | string |
address.coordinates | Geo-location, expressed as [lat, lon] | string |
offer.validationId | Obtained via pre-validations call for courier, see 'Dispatch Availability' | string |
{
"type": "dispatch",
"time": "2024-01-15T10:00",
"address": {
"line": "Foreestelaan 82, 9000 Gent, Belgium",
"coordinates": [51.03162341734958, 3.7337162550022622]
},
"offer": {
"validationId": "62********************3e"
}
}