Skip to content

Latest commit

 

History

History
253 lines (232 loc) · 7.76 KB

File metadata and controls

253 lines (232 loc) · 7.76 KB

OrderSummary

Properties

Name Type Description Notes
orderId Integer Order identifier [optional]
deliveryType DeliveryTypeEnum Delivery type [optional]
pickupLocationType PickupLocationTypeEnum Pickup location type [optional]
tableServiceCatagory TableServiceCatagoryEnum Table service category [optional]
orderState OrderStateEnum Order state [optional]
requestedForTime OffsetDateTime Order requested for [optional]
storeName String Name of the store [optional]
storeIanaTimeZone String Store IANA time zone [optional]
customerName String Name of the customer [optional]
customerPhoneNumber String Phone number of customer [optional]
amount Double This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee It does include the OnlineOrderingFee [optional]
refundedAmount Double Refunded amount [optional]
paymentAccountType PaymentAccountTypeEnum Payment Account [optional]
paymentStatus PaymentStatusEnum Status of the payment [optional]
currency CurrencyEnum Currency of payment [optional]
appType AppTypeEnum Type of app end user is on [optional]
localOrderId String Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) [optional]
dropOffLocationId Integer id of the collection/drop off location [optional]
dropOffLocation String Represents table service drop off location [optional]
acceptedFor OffsetDateTime Time store has accepted the order for [optional]
channel Channel Channel where the Order comes from [optional]
inFraudZone Boolean Was order made within a fraud zone [optional]
unusualHighValueOrder Boolean Is order of unusually high value [optional]
channelOrderId String ChannelOrderId from external channel [optional]
channelOrderDisplayId String ChannelOrderDisplayId from external channel [optional]
orderDropOffLocation OrderDropOffLocation DropOffLocation selected for this order [optional]
orderBatchInfo OrderBatchSummary OrderBatch information [optional]
deliveryLocation DeliveryLocation Delivery location details [optional]

Enum: DeliveryTypeEnum

Name Value
DELIVERY "Delivery"
PICKUP "Pickup"

Enum: PickupLocationTypeEnum

Name Value
TAKEOUT "TakeOut"
TABLESERVICE "TableService"
DINEIN "DineIn"

Enum: TableServiceCatagoryEnum

Name Value
GENERIC "Generic"
VILLA "Villa"
HOUSE "House"
ROOM "Room"
AREA "Area"
TABLE "Table"
PARKINGBAY "ParkingBay"
GATE "Gate"
DRIVETHROUGH "DriveThrough"
TEAM "Team"

Enum: OrderStateEnum

Name Value
CREATED "Created"
PLACEDCANBECANCELLED "PlacedCanBeCancelled"
READYTOPROCESS "ReadyToProcess"
ACCEPTEDBYRESTAURANT "AcceptedByRestaurant"
DISPATCHED "Dispatched"
DELIVERED "Delivered"
CANCELLED "Cancelled"
MANUALREVIEW "ManualReview"
REJECTEDBYSTORE "RejectedByStore"
REJECTEDBYFLIPDISH "RejectedByFlipdish"
REJECTEDAUTOMATICALLY "RejectedAutomatically"
REJECTEDAFTERBEINGACCEPTED "RejectedAfterBeingAccepted"
ACCEPTEDANDREFUNDED "AcceptedAndRefunded"
PENDINGPAYMENT "PendingPayment"

Enum: PaymentAccountTypeEnum

Name Value
CARD "Card"
CASH "Cash"
IDEAL "Ideal"
BANCONTACT "Bancontact"
GIROPAY "Giropay"
EPS "Eps"
EMV "Emv"
PAYPAL "PayPal"
PAYGREEN "PayGreen"
GOOGLEWALLETTOKEN "GoogleWalletToken"

Enum: PaymentStatusEnum

Name Value
PAID "Paid"
UNPAID "Unpaid"
REFUNDED "Refunded"
PARTIALLYREFUNDED "PartiallyRefunded"
DISPUTED "Disputed"

Enum: CurrencyEnum

Name Value
EUR "EUR"
USD "USD"
GBP "GBP"
CAD "CAD"
AUD "AUD"
DJF "DJF"
ZAR "ZAR"
ETB "ETB"
AED "AED"
BHD "BHD"
DZD "DZD"
EGP "EGP"
IQD "IQD"
JOD "JOD"
KWD "KWD"
LBP "LBP"
LYD "LYD"
MAD "MAD"
OMR "OMR"
QAR "QAR"
SAR "SAR"
SYP "SYP"
TND "TND"
YER "YER"
CLP "CLP"
INR "INR"
AZN "AZN"
RUB "RUB"
BYN "BYN"
BGN "BGN"
NGN "NGN"
BDT "BDT"
CNY "CNY"
BAM "BAM"
CZK "CZK"
DKK "DKK"
CHF "CHF"
MVR "MVR"
BTN "BTN"
XCD "XCD"
BZD "BZD"
HKD "HKD"
IDR "IDR"
JMD "JMD"
MYR "MYR"
NZD "NZD"
PHP "PHP"
SGD "SGD"
TTD "TTD"
XDR "XDR"
ARS "ARS"
BOB "BOB"
COP "COP"
CRC "CRC"
CUP "CUP"
DOP "DOP"
GTQ "GTQ"
HNL "HNL"
MXN "MXN"
NIO "NIO"
PAB "PAB"
PEN "PEN"
PYG "PYG"
UYU "UYU"
VEF "VEF"
IRR "IRR"
XOF "XOF"
CDF "CDF"
XAF "XAF"
HTG "HTG"
ILS "ILS"
HRK "HRK"
HUF "HUF"
AMD "AMD"
ISK "ISK"
JPY "JPY"
GEL "GEL"
KZT "KZT"
KHR "KHR"
KRW "KRW"
KGS "KGS"
LAK "LAK"
MKD "MKD"
MNT "MNT"
BND "BND"
MMK "MMK"
NOK "NOK"
NPR "NPR"
PKR "PKR"
PLN "PLN"
AFN "AFN"
BRL "BRL"
MDL "MDL"
RON "RON"
RWF "RWF"
SEK "SEK"
LKR "LKR"
SOS "SOS"
ALL "ALL"
RSD "RSD"
KES "KES"
TJS "TJS"
THB "THB"
ERN "ERN"
TMT "TMT"
BWP "BWP"
TRY "TRY"
UAH "UAH"
UZS "UZS"
VND "VND"
MOP "MOP"
TWD "TWD"
BMD "BMD"

Enum: AppTypeEnum

Name Value
UNKNOWN "Unknown"
IOS "Ios"
ANDROID "Android"
WEB "Web"
KIOSK "Kiosk"
POS "Pos"
TELEPHONECALL "TelephoneCall"
SMS "Sms"
PWAANDROID "PwaAndroid"
PWAIOS "PwaIos"
GOOGLE "Google"