latestOpenAPI 3.0.02026-08-0831117.0 KB
d62de4d3b8bd
Orders
Get an Order that was made in the system
get/order/{external_id}
Response
Success if the order was retrieved
admin_user_idinteger
Admin user id for order
business_idinteger
Business id
business_slugstring
business slug
cancelled0 | 1
order is cancelled
coupon_used0 | 1
was coupon used
currency_codestring
Code of the currency used
created_timestring YY-DD-MMTHH:MM:SS.MS
Time order was created
delivery_feenumber float
Delivery fee for order
delivery_mode0 | 1 | 2 | 3 | 4
Delivery Mode:
- 0 - Direct to Location
- 1 - Yay Food Pole
- 2 - Pickup Area
- 3 - Direct to Customer
- 4 - Last Yard
emailstring
User email
guest_checkout0 | 1
Whether the order is guest checkout
issuer_idinteger
order issuer id
menu_type0 | 1 | 2 | 3
Menu Type:
- 0 - Default
- 1 - Event
- 2 - Embedded
- 3 - Donation
- 4 - Ecommerce
- 5 - Pre-Packaged
needs_supervisor0 | 1
Whether order needs supervisor or not
order_idstring
Id for the order
order_method0 | 1
Order Method:
- 0 - APP
- 1 - KIOSK
paid_amountnumber
Amount paid
payment_method1 | 2 | 3 | 4 | 5 | 6
Menu Type:
- 1 - CC
- 2 - APPLE
- 3 - GPAY
- 4 - CASH
- 5 - BUSINESS_BILLING
- 6 - DIRECT_TO_BILL
pricenumber float
Order price
rel_order_idstring
Id of original order if this order is a duplicate
scheduled_datestring
Date scheduled for preorders
scoreinteger
Customer rating for the order
suppress_msgs0 | 1
Whether or not the customer wants texts
survey_sent0 | 1
Whether survey was sent for order or not
tablenumber
Table number for order
tipnumber
Order tip amount
user_addrstring
User address line 1
user_addr_line_2string
User address line 2
user_citystring
User city
user_countrystring
User country
user_idinteger
User id
user_namestring
User name
user_phonestring
User phone
user_zipstring
User zip