| Name | Description | Type | Additional information |
|---|---|---|---|
| ChannelOrderUniqueIdentifier | string |
None. |
|
| ChannelName | string |
None. |
|
| HashKey | string |
None. |
|
| UniqueRequest | string |
None. |
|
| OrderID |
Primary Key of order, will receive in response of Order API |
integer |
None. |
| TerminalID | integer |
None. |
|
| OfflineUniqueID |
Unique identification for order from POS Application |
string |
Required |
| OrderNo |
Sequence of order on daily basis from App |
integer |
Required Range: inclusive between 1 and 2147483647 |
| TransactionNo |
Server Side sequence number for location's order, provide in response of order API |
integer |
None. |
| DeviceTransactionNo | integer |
None. |
|
| OrderReferenceId |
3rd party order refrence number, will be blank of order punch from App |
string |
None. |
| AgentId |
Agent for delivery (It will be subuserid), will be Null if there is no agent assigned to the order |
integer |
None. |
| CustomerId |
ID(Primary Key) of customer attached with order |
integer |
None. |
| CustomerName | string |
None. |
|
| CustomerMobileNumber | string |
None. |
|
| ClientCreatedDate |
Datetime of order creation on POS this will be client side date time. Format will be yyyy-MM-dd-hh-mm-ss (2018-12-16-11-11-00) |
string |
Required Matching regular expression pattern: ^\d{4}-\d{2}-\d{2}-\d{2}-\d{2}-\d{2}$ |
| BusinessDate |
Business date for the order. Format will be yyyy-MM-dd-hh-mm-ss (2018-12-16-00-00-00) |
string |
Required Matching regular expression pattern: ^\d{4}-\d{2}-\d{2}-\d{2}-\d{2}-\d{2}$ |
| OrderTypeId |
ID (Primary Key) of OrderType received from API |
integer |
Required |
| TableId |
Table ID (Primary Key) if any table mapped with order |
integer |
None. |
| TableTitle |
Table Title [Asked from Ahmad to give] |
string |
None. |
| GuestCount |
Number of chairs on table |
integer |
None. |
| OrderState |
ENUM : State of order describe the order condition in kitchen. It will be by default "InKitchen = 2" from POS. |
OrderState |
Required |
| PayStatus |
ENUM : Payment status of order. If customer will pay later it will be 0, for paid order it will be 1 |
PayStatus |
Required |
| ProcessedOffline |
If app don't have internet access we have to complete the order in offline mode, when that type of orders will sync to server this field will be 'true' otherwise in request it will be 'false' |
boolean |
Required |
| Comments |
Any comment for order from customer |
string |
None. |
| DeliveryAddress |
Address for Delivery, If required for order other wise it will be blank |
string |
None. |
| OrderTakenBy |
The primary key of user who punched or saved the order |
integer |
Required |
| CheckoutBy |
The primary key of user who checkout the order. --0 if checkout model is null |
integer |
None. |
| SubUserID |
The primary key of user who is sending or updating order on server |
integer |
Required |
| Status |
ENUM : Status will be 301 for order, if order punch from App. Used to show the condition of whole order |
OrderStatus |
Required |
| Mode |
Mode uses to indentify order will insert, update or delete in database. Could be New,Update or Delete For Insert use "New", to update the order use "Update" and for delete order use "Delete" |
ModificationMode |
Required |
| PrintStatus | string |
None. |
|
| OrderDetails |
Items to save with Order, All new items or have changes to reflect on server should provide in this array |
Collection of OrderDetailDto |
None. |
| OrderCheckout |
All details related to checkout/payment of order will come in this model |
OrderCheckoutDto |
None. |
| ExternalReference |
Any data related to 3rd party/partner |
ExternalReference |
None. |
| IsMarnNow | boolean |
None. |
|
| MarnNowPartner | integer |
None. |
|
| DeliveryDetails | DeliveryDetail |
None. |
|
| IssuedbyCashier | boolean |
None. |
|
| PartnerDetails | PartnerInfo |
None. |
|
| AppliedTaxes | Collection of AppliedTax |
None. |
|
| AppliedDiscounts | Collection of AppliedDiscount |
None. |
|
| Desc |
Desc from server |
string |
None. |
| VoidReasonID | integer |
None. |
|
| StatusNotes | string |
None. |
|
| PartnerAutoAccept | boolean |
None. |
|
| PayLinkData | PaymentLink |
None. |