Pickup Order Object

Attributes

orderId Integer

Unique identifier for an order


orderNumber String

Unique order reference number for the pickup order


additionalId String

Additional identifier for the pickup order


restaurant Object

Restaurant information for the pickup order

Child attributes


name String

Name of the restaurant


address String

Address of the restaurant


phone String

Phone number of the restaurant


customer Object

Customer information for the pickup order

Child attributes


name String

Name of the customer


phone String

Phone number of the customer


email String

Email address of the customer


tips Double

Tip amount for the pickup order


tax Double

Tax amount for the pickup order


discountAmount Double

Discount amount applied to the pickup order


totalOrderCost Double

Total cost of the pickup order including all fees and taxes


orderItem Array

Array of order item objects

Order Item object child attributes


name String

Name of the order item


quantity Integer

Quantity of the order item


unitPrice Double

Price of the order item per unit


addOns Array

Array of add-on item names (optional)


paymentMethod String

Payment method used for the pickup order


pickupInstruction String

Special instructions for the pickup order


expectedPickupDate String

Expected pickup date for the order (yyyy-mm-dd format)


expectedPickupTime String

Expected pickup time for the order (hh:mm:ss format)


orderSource String

Source platform or channel from where the order originated

Supported Payment Method values
CARD
CASH

Pickup Order Object

{
   "orderNumber": "99qT5A",
   "additionalId": "4532",
   "restaurant": {
       "name": "Popeyes Louisiana Kitchen",
       "address": "890 Geneva Ave, San Francisco, CA 94112, United States",
       "phone": "+14152392013"
   },
   "customer": {
       "name": "Mr. Jhon Mason",
       "phone": "+14152392212",
       "email": "jhonMason@gmail.com"
   },
   "tips": 2.5,
   "tax": 1.5,
   "discountAmount": 1.5,
   "totalOrderCost": 13.47,
   "orderItem": [
       {
           "name": "Veggie Duck",
           "quantity": 2,
           "unitPrice": 14.95,
           "addOns": [
               "Onion Rings",
               "Sauce"
           ]
       },
       {
           "name": "Mango Chicken",
           "unitPrice": 13.95,
           "quantity": 2
       }
   ],
   "paymentMethod": "CARD",
   "pickupInstruction": "fast",
   "expectedPickupDate": "2025-09-18",
   "expectedPickupTime": "20:45:00",
   "orderSource": "Seamless"
}