Update Basket - Fulfillment Details

Purpose

Modify the fulfilment type and its associated parameters and/or update the requested fulfilment time.

Fulfillment Types:

TypeDefinition
deliveryCommerce platform will be arranging delivery
pickupWill be collected i.e. for takeaway (can apply for Kiosk orders)
curbsideWill be as per pickup, but specific handoff to customer in vehicle
eat-inCustomer will be ordering on-premise e.g. QR Code ordering
dispatchDistinct 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

ParameterMeaningType
*timeThe intended pickup time for the orderstring
address.lineFull address in single linestring
address.coordinatesGeo-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

ParameterMeaningType
pickupNotesSpecial instructions from the customer on their Curbside order e.g. Car moderl/colour/registrationstring
  {
      "type": "curbside",,
      "pickupNotes":"Yellow Honda"
  }

Eat-In

ParameterMeaningType
spotSpecific location in the venue e.g. the table number or position at a counterstring

  {
      "type": "eatIn",
      "spot": "table 2"
  }

Dispatch

ParameterMeaningType
address.lineFull address in single linestring
address.coordinatesGeo-location, expressed as [lat, lon]string
offer.validationIdObtained 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"
      }
  }

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!