Updating Fullfillment Type

Step 2: Indicate the Fulfilment Type

Once an order has been created, it needs to be fulfilled with one of the following Fulfillment Methods:

Delivery by Operator (delivery-by-operator)

The merchant themselves have a delivery driver and will be doing the delivery to the final customer

The available fields for delivery-by-operator are:

Field Nullable Type Description
deliveryTime string Driver's delivery deadline. Must be specified in ISO 8601 .
deliveryNotes string Customer's notes for the Delivery Driver.
deliveryCharge float Any delivery charge to be applied to the order
customerName string Customer's name.
customerPhone string Customer's phone.
customerEmail Yes string Customer's e-mail.
addressLineOne string Customer's address
addressLineTwo string Customer's address
city string Customer's city
postcode string Customer's address post code
kitchenNotes string Customer's notes for the kitchen.
coordinates Yes object Customer's address coordinates
coordinates.latitude float Delivery Address Latitude
coordinates.latitude float Delivery Address Longitude

Request Sample

POST /ordering/v3/order/{orderId}/fulfillment-type/delivery-by-operator
{  
  "deliveryTime": "2019-03-21T15:14:36+00:00",  
  "deliveryNotes": "notes left by the customer for the delivery driver",  
  "deliveryCharge": 2.20,  
  "customerName": "Jack Sparrow",  
  "customerPhone": "+44 1234 5678 90",  
  "customerEmail": "test@flyt.io",  
  "addressLineOne": "123 Flyt Road",
  "addressLineTwo": "",  
  "city": "London",
  "postcode": "FL1P 41",
  "kitchenNotes": "No nuts please",    
  "coordinates": {
    "latitude": 51.516548,
    "longitude": -0.103376
  }
}  

Response Sample

202 Accepted  

Delivery by Delivery Partner (delivery-by-delivery-partner)

The merchant uses a 3rd party service provider (e.g. JustEat, UberEats, Deliveroo, others) to deliver the order to the final customer

The available fields for delivery-by-delivery-partner are:

Field Nullable Type Description
collectionTime string Delivery Partner's collection time. Must be specified in ISO 8601 .
collectionNotes string Customer's notes for the Delivery Driver.
name string Collector's name (or Driver's Phone Name) .
phone string Collector's phone (or Driver's Phone number) .
orderReference string Delivery Partner's Reference Number. Used by the restaurant to idenfity which order to give to the driver. (This reference shows in the receipt) .
kitchenNotes string Customer's notes for the kitchen.
customer Yes object Customer's information
customer.name string Customer's name
customer.phone string Customer's phone number
customer.email string Customer's e-mail
customer.address object Customer's address
customer.address.lineOne string Customer's address
customer.address.lineTwo string Customer's address
customer.address.city string Customer's city
customer.address.postcode string Customer's address post code
customer.address.coordinates object Customer's address coordinates
customer.address.coordinates.latitude float Delivery Address Latitude
customer.address.coordinates.latitude float Delivery Address Longitude

Request Sample

POST /ordering/v3/order/{orderId}/fulfillment-type/delivery-by-delivery-partner  
{
    "collectionTime": "2019-03-21T15:14:36+00:00",
    "collectionNotes": "",
    "kitchenNotes": "No nuts please",
    "name": "Davy Jones",
    "phone": "+44 1234 5678 90",
    "orderReference": "xs10zgpqnue9oqv4ovk3ba",
    "customer": {
        "name": "Jack Sparrow",
        "phone": "+44 1234 5678 90",
        "email": "test@flyt.io",
        "address": {
            "lineOne": "123 Flyt Road",
            "postcode": "FL1P 41",
            "city": "London",
            "coordinates": {
                "latitude": 51.516548,
                "longitude": -0.103376
            }
        }
    }
}
  

Response Sample

202 Accepted  

Collection by Customer (collection-by-customer)

The customer will collect the order from the location

The available fields for collection-by-customer are:

Field Nullable Type Description
collectionTime string Delivery Partner's collection time Must be specified in ISO 8601 .
collectionNotes string Customer's notes for the Delivery Driver.
name string Customer's name.
phone string Customer's phone.
orderReference string Order's Reference used by the restaurante to identify to which customer should collect the order. (This reference shows in the receipt) .
kitchenNotes string Customer's notes for the kitchen.

Request Sample

POST /ordering/v3/order/{orderId}/fulfillment-type/collection-by-customer
{  
  "collectionTime": "2019-03-21T15:14:36+00:00",  
  "collectionNotes": "No nuts please",  
  "kitchenNotes": "No nuts please",  
  "name": "Jack Sparrow",  
  "phone": "+44 1234 5678 90",  
  "orderReference": "xs10zgpqnue9oqv4ovk3ba"
}  

Response Sample

202 Accepted  

Order at Table (order-at-table)

The customer is ordering at a table at the location

The available fields for order-at-table are:

Field Nullable Type Description
kitchenNotes string Customer's notes for the kitchen.
tableNumber int Customer's table number.

Request Sample

POST /ordering/v3/order/{orderId}/fulfillment-type/order-at-table
{  
  "kitchenNotes": "No nuts please",  
  "tableNumber": 12
}  

Response Sample

202 Accepted