Required
serviceModeID :
string (GUID)
The ID of the service mode to create this order on
Required
MaxLength(8)
serviceModeEntityID :
string
The Entity ID (eg table number, tab number etc) to create this order one
Required
products :
OrderNPayProduct
[]
A list of products for the order
Nullable
MaxLength(64)
providerOrderID :
string
The unique order id from the provider's perspective
applyAutomaticAdjustments : bool
Should the simulation apply automatic adjustments to the resulting order?
useProviderPrices : bool
When True, the simulation will use the product pricing specified explicitly in the products records of this request by the provider.
When False, the simulation will determine its own prices based on the current service mode, price scheme and price schedules for each product.
Note: When Payments are included in the request, this value is always considered to be TRUE (ie provider prices are ALWAYS used when payments are included)
Nullable
payments :
OrderNPayPayment
[]
A list of payments for the order
Nullable
adjustments :
OrderNPayAdjustment
[]
A list of adjustments for the order
Nullable
notes :
OrderNPayNote
[]
A list of order tags for the order
Nullable
decimal(13, 2)
serviceChargeAmount :
number (decimal)
The service charge amount for the order
0+ = an explicit service charge amount
NULL = no explicit service charge amount, automatic service charges may be applied by the POS.
Example
{
"serviceModeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"serviceModeEntityID": "string value",
"products": [],
"providerOrderID": "string value",
"applyAutomaticAdjustments": true,
"useProviderPrices": true,
"payments": [],
"adjustments": [],
"notes": [],
"serviceChargeAmount": 1.23
}