Catering Orders

GET Read Catering Orders /catering-orders/read/:id

A catering-order is an individual order from a catering partner or internal order. A catering-order has two stages, most orders typically start off as a scheduled-order and are turned into finalized-order, this is to allow an order to exist even when the full details of the order are not yet final. NOTE* You will only have access to orders that have been created via api.

Response

Name	Value	Description	Required
id	string	Unique Id	true
date	string	Date of order (format: YYYY-MM-DD)	true
channel	string	Catering Platform Channels (See list of available channels)	true
orderDate	string	Full date UTC in ISO format	true
location	string	Location name	true
locationId	string	Location id	true
finalizedOrder	boolean	Specifies whether order has been finalized	true
restaurant	string	Restaurant name	false
restaurantId	string	Restaurant id	false
mealsEstimate	number	If order is not finalized, you can specify an estimate of meals	false
files	object	An object with keys as file names and values of the files url	false
orderId	string	Order id provided by channel	false
utensils	boolean	Specifies whether order requires utensils	false
totalMeals	number	Total meals for order	false
meals	object array	Array of meals with itemName, quantity, modfiers[]	false
headCount	number	Total Headcount for order	false
customerName	string	Name of customer for order	false
cancelled	boolean	Specifies whether order has been cancelled	false
totalCost	number	Grand total for order in dollars	false
orderTotal	number	Total for just order in dollars	false
tax	number	Tax total in dollars	false
totalPreTax	number	Order Total Pre-Tax in dollars	false
deliveryFee	number	Delivery Fee for order in dollars	false
serviceFee	number	Service fee in dollars	false
gratuity	number	Gratuity in dollars	false
discount	number	Discount by channel in dollars	false
additionalFees	number	Any additional fees for order in dollars	false
comission	number	Commission for location in dollars	false
tip	number	Tips in dollars	false
deliveryPhone	string	Delivery phone to contact in case of problems with delivering (format: +XXXXXXXXXXX)	false
deliveryInstructions	string	Delivery Instructions	false
deliveryAddress	string	Delivery Address (ex. 123 Street Ave, San Francisco CA 12345, USA)	false

Authorization Bearer Token

Token                             API_Key

Headers

Content-Type                 application/json

Example

import axios from "axios"; 

const headers = {
    "Authorization": `Bearer ${your_api_key}`,
    "Content-Type": "application/json"
};

const rootUrl = "https://us-central1-checklist-admin-d0013.cloudfunctions.net/api/v1";
 
const orderId = "order-id"; 

const request = axios(rootUrl+`/catering-orders/read/${orderId}`, { headers });

Body Response JSON

{
     "id": "3d151e13-fd3e-4bbb-8066-4faf076899f4",
     "date": "2024-01-04",
     "channel": "Forkable",
     "orderDate": "2024-01-04T01:30:00.000+05:00",
     "location": "Houston",
     "locationId": "59a87f79-2219-43d0-b607-dc0c4f3fc09b",
     "finalizedOrder": true,
     "restaurant": "Burger Palace",
     "restaurantId": "b4eb9c2a-861c-4273-81b7-85beedba86e3",
     "mealsEstimate": 8,
     "files": {
      "receipt": "https://example.com/labels/example.pdf"
     },
     "orderId": "order-zeimpatzp",
     "utensils": "true",
     "totalMeals": 10,
     "meals": [
      {
       "itemName": "Pizza",
       "quantity": 3,
       "modifiers": [
        {
         "modifierName": "Gluten-Free",
         "quantity": 3
        }, 
       ]
      },
      {
       "itemName": "Pasta",
       "quantity": 7,
       "modifiers": [
        {
         "modifierName": "No Onions",
         "quantity": 3
        }
       ]
      }
     ],
     "headCount": 6,
     "customerName": "Jorge Reyes",
     "cancelled": true,
     "totalCost": 91.46,
     "tax": 5.73,
     "totalPreTax": 71.63,
     "orderTotal": 32.78,
     "deliveryFee": 2.41,
     "serviceFee": 3.84,
     "gratuity": 10.74,
     "discount": 8.8,
     "additionalFees": 1.52,
     "commission": 7.16,
     "tip": 4.38,
     "deliveryPhone": "+12345678912",
     "deliveryInstructions": "Leave at the door",
     "deliveryAddress": "123 Street Ave, San Francisco CA 12345, USA"
}