Glossary - Create Orders (Delivery Only)

ⓘ Required Data
Please note that all the fields marked with ( * ) are required.

Parameters	Meaning	Type
`validationId` *	`validationId` returned from the dispatch availabilityendpoint. The ID cannot be reused and is valid for 10 minutes from generation. If expired `validationId` is sent, the request fails with error 417	string
`channelOrderId` *	The full unique ID from the ordering channel, cannot be reused within 48hr after pickup (across all accounts)	string
`channelOrderDisplayId` *	A more human-readable ID provided by the channel	string
`orderType` *	It should default to 2, indicating it is a delivery order `"orderType": 2`.	integer
customer *	customer or end-user	object
customer.`name` *	The name of the customer	string
customer.`phoneNumber` *	Contact phone number	string
customer.`email`	Contact email of the customer	string
deliveryAddress	The delivery address	object
deliveryAddress.`street` *	The full street address in a single-line string	string
deliveryAddress.`streetNumber`	numerical addresses assigned to homes, businesses, and other properties *Please do not repeat it If the number has been already provided on the "street" field.	string
deliveryAddress.`postalCode` *	The postal or zip code	string
deliveryAddress.`city` *	City	string
deliveryAddress.`country`	Country	string
deliveryAddress.`extraAddressInfo`	Additional instructions for locating the customer's location	string
deliveryAddress.`coordinates` *	Object containing longitude and latitude expressed as below; "coordinates": { "coordinates": [ 9.124598503112793, 45.50004196166992 ] }	array
payment *	The process of paying the order.	object
payment.`amount` *	The total amount paid should be sent as an integer with 2 decimal digits, for example, 1 euro would be sent as 100. payment amount = _sum of prices of all products in the order + `deliveryCost` + `serviceCharge` + `deliveryCostTax` + `serviceChargeTax` + sum of all tax amounts in the taxes array##	integer
payment.`type` *	Type of payment(cash,card). See section here.	integer
items *	Array of objects containing the items to be ordered.	array (object)
items.`plu` *	Stands for Price Look Up. The unique code of a product. It can be hardoded with a standard value.	string
items.`name` *	name of the product or modifier	string
items.`price` *	Price for each of the items. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.	integer
items.`quantity` *	number of items	integer
items.`subItems`	(where applicable)	array
`deliveryIsAsap` *	The boolean indicates whether a delivery is asap or not.	boolean
`pickupTime` *	Timestamp is in UTC `yyyy-MM-ddTHH:mm:ssZ`all time values in our API are in UTC time as per ISO8601	string
`deliveryTime` *	Timestamp is in UTC `yyyy-MM-ddTHH:mm:ssZ`all time values in our API are in UTC time as per ISO8601	string
`courier` *	This specifies who is delivering an order. It should default to "restaurant" to be fulfilled by an integrated 'Dispatch' partner.	string
`orderIsAlreadyPaid` *	The boolean indicates whether the order has already been paid or not.	boolean
`ageCheck` *	Boolean indicating whether the driver should verify customer's age.	boolean
`decimalDigits` *	The specific decimal quantity sent on the order using the "decimalDigits" attribute. The default should be “decimalDigits”: 2 . Note: 3 decimal digits may apply in certain regions. See information here.	integer
taxes	A consumption tax imposed by the government on the sale of goods and services. *Required on tax exclusive locations US/Canada.	array (object)
taxes.`taxClassId`	An ID corresponding to this tax class as used by Deliverect (not currently needed) *Required on tax exclusive locations US/Canada.	integer
taxes.`name`	The display name for this category of taxes, which is how it should be printed on a receipt (not currently needed) *Required on tax exclusive locations US/Canada.	string
taxes.`total`	See section here for more details. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100. *Required on tax exclusive locations US/Canada.	integer
`driverTip`	A tip intended for the courier (see section here) It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.	integer
`deliveryCost`	Cost of delivery applied. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.	integer
`deliveryCostTax`	Cost of delivery tax. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.	integer
`serviceCharge`	Cost of any service charges. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 10	integer
`serviceChargeTax`	Service charges tax. It should be sent as an integer with 2 decimal digits e.g. 1 euro would be sent as 100.	integer
`discountTotal`	Ordering platforms may offer multiple forms of discount in accordance with the restaurants, e.g. special offers on selected items, % discounts etc. A discount total is sent as a minus value representing the deduction from the total order. (see guide here). It should be sent as a negative integer with 2 decimal digits e.g. 1 euro would be sent as -100.	integer (negative)