Basket Model

storeId *

A storeId is the unique identifier for a store–channel (ordering platform) at a specific location. and may also be referenced as channelLinkId

In order to retrieve the stores existing on a specific location the GET STORES should be used

string

fulfillment

Defines how the order will be fulfilled.

Object

fullfillment.type *

Types of orders to be included inside on the fulfilllment object. These are the allowed values

_pickup- Takeaway orders

_delivery - Delivery handled directly by the ordering platform

_eatIn - Orders consumed on premises (dine-in)

_dispatch - Delivery handled by an external dispatch system connected via Deliverect (requires validation call)

enum

time

Timestamp is in UTC yyyy-MM-ddTHH:mm:ssZ all time values in our API are in UTC time as per ISO8601

*(for delivery, pickup and any non-asap order)

string

address

Delivery address information for the order. Required when type = "delivery"

object

address.line

Full formatted delivery address line Example: "Foreestelaan 82, 9000 Gent, Belgium"

string

address.coordinates

Geographical coordinates of the delivery address in [long, lat] order, used for precise location mapping and routing. eg., [51.03162341734958, 3.7337162550022622]

Array

spot

Identifier of the dining spot (such as a table number)

Required when type = "eatIn"

string

note

Optional free-text field that contains special instructions or comments from the customer about the order (e.g., cooking preferences, dietary requests, packaging notes)

string

items

List of products the customer wants to order

array of objects

items.menuId

internal Deliverect menu id. You can retrieve the menuId via GET Store Menu

string

items.plu

Unique identifier of the item, to be used when creating orders

string

items.quantity

Number of units of the item added to the basket

integer

items. note

Special instructions for the item

string

items. subItems

modifiers applied to the parent item. Each subItem corresponds to a chosen modifier (where applicable)

array of objects

subItems. plu

Unique identifier of the item (modifier)

string

subItems.customizationPlu

PLU of the modifier group that the subItem belongs to

string

subItems. quantity

Number of times this modifier is applied to the item

integer

customer

Information about the customer placing the orde

object

customer. name

Full name of the customer

string

customer.companyName

Name of the company or organization associated with the order.

string

customer.phoneNumber

Customer’s contact number for order confirmation or delivery communication. Eg., "+3211223344"

string

customer.email

Customer’s email address

string

customer. externalId

External reference ID for the customer in a third-party system

string