Update Basket - Fulfillment Details

Every PATCH request triggers a full recalculation of the basket, including item prices, taxes, discounts, charges and totals, so the basket returned always reflects the latest state.

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

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": "5030 W Lovers Ln, Dallas, TX 75209, US",
        "coordinates": [
            32.850713,
            -96.828014
        ],
        "note": "first floor, left door, happy dog"
    }
}

Pickup

ParameterMeaningType
timeThe intended pickup time for the orderstring
pickupNotesSpecial instructions from the customer on their Pickup order e.g. pager numbers/table numbersstring

Example Request

  {
      "type": "pickup",
      "time": "2024-01-15T10:00",
      "pickupNotes":"Table number 7"
  }

Curbside

ParameterMeaningType
pickupNotesSpecial instructions from the customer on their Curbside order e.g. Car moderl/colour/registrationstring

Example Request

  {
      "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"
  }
Path Params
string
required

accountId is the unique identifier of the customer account in Deliverect

string
required
Body Params

Fulfillment details to set on the basket.

string
enum
required

Types of orders to be included inside the fulfillment object. These are the allowed values:

  • pickup - Takeaway orders
  • delivery - For delivery orders (including those handled by 3rd party dispatch platforms)
  • eatIn - Orders consumed on premises (dine-in)
  • curbside - Pickup orders handed over to the customer at the curb, outside the store
  • driveThru - Orders collected by the customer at the store's drive-thru
Allowed:
date-time

Timestamp in UTC, yyyy-MM-ddTHH:mm:ss.SSSSSSZ. All time values in our API are in UTC time as per ISO8601.

(For delivery, pickup, and any non-ASAP order.)

address
object

Delivery address information for the order. Required when type is delivery.

string | null
enum

How a delivery order is handed over to the guest. Delivery only; omit or send null if not captured. Passed to the order as deliveryInfo.dropoffType.

  • curbside - Handed over at the curb
  • leaveatdoor - Contactless, left at the door
  • door - Handed to the guest at the door
Allowed:
string

Comments relevant to order collection, e.g. the make of car for curbside orders.

string

Identifier of the dining spot, such as a table number. Required when type is eatIn.

Responses

409

Conflict — a concurrent update to the basket was detected

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json