Glossary - Channel Orders

Parameters	Meaning	Type
customer	customer or end-user
customer.`name`	The name of the customer	string
customer.`companyName`	A company name where the order is placed from	string
customer.`phoneNumber`	Contact phone number	string
customer.`phoneAccessCode`	Where a contact centre is used to route calls using a unique code	string
customer.`email`	Contact email of the customer	string
customer.`note`	Additional note on the customer	string
customer.`tin`	Tax Identification Number	string
deliveryAddress	The delivery address
deliveryAddress.`street`	The full street address in a single-line string	string
deliveryAddress.`streetNumber`	numerical addresses assigned to homes, businesses, and other properties	string
deliveryAddress.`postalCode`	The postal or zip code	string
deliveryAddress.`area`	The name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit	string
deliveryAddress.`city`	City	string
deliveryAddress.`country`	Country	string
deliveryAddress.`extraAddressInfo`	Additional instructions for locating the customer's location	string
deliveryAddress.`coordinates`	`"coordinates": { "longitude":, "latitude": } e.g. "coordinates": { "longitude": 9.0116776287441, "latitude": -79.516039105483 }`	array
payment	The process of paying the order.
payment.`amount` *	The total amount paid should be sent as an integer with 2 decimal digits, for example, 5 euros would be sent as 500 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` *		integer
payment.`due`	Paid amount	integer
payment.`rebate`	See section here for more info	integer
payment.`commissionType`	The type of commission rate charged can be categorised	string
taxes	A consumption tax imposed by the government on the sale of goods and services.
taxes.`taxClassId`	An ID corresponding to this tax class as used by Deliverect (not currently needed)	integer
taxes.`name`	The display name for this category of taxes, which is how it should be printed on a receipt (not currently needed)	string
taxes.`total` *	* for Tax Exclusive Locations See section here for more details	integer
items
items.`plu` *	Stands for Price Look Up. The unique code of a product.	string
items.`price` *	the amount of payment	integer
items.`quantity` *	number of items	integer
items.`remark`	item level notes	string
items.`name` *	name of the product or modifier	string
items.`subItems`	(where applicable)	array
`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` *		integer
`table`	For 'Eat-in' orders, a table number can be provided	string
`pickupTime`	Timestamp is in UTC `yyyy-MM-ddTHH:mm:ssZ`all time values in our API are in UTC time as per ISO8601 *(for delivery, pickup and any non-asap order)	string
`estimatedPickupTime`	Timestamp is in UTC `yyyy-MM-ddTHH:mm:ssZ`all time values in our API are in UTC time as per ISO8601 If your channel doesn't use an estimate for the pickup time, the easiest thing to do is to reuse `pickupTime`, and just send the same value for `estimatedPickupTime`.	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
`deliveryIsAsap` *		boolean
`courier`	This specifies who is delivering an order. There are only two possible variations • A channel handling delivery for the restaurant * must specify their channel name as "courier" • If the channel is not set, the assumption is the restaurant are arranging their own delivery, and "restaurant" is set and is needed where orders are fulfilled by an integrated 'Dispatch' partner (see guide here for further info)	string
`orderIsAlreadyPaid` *		boolean
`note`	order note	string
`decimalDigits` *		integer
`deliveryCost`	cost of delivery applied	integer
`deliveryCostTax`	cost of delivery tax	integer
`serviceCharge`	cost of any service charges	integer
`serviceChargeTax`	service charges tax	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)	integer (negative)
discounts	See the complete guide here	array of objects
discounts.`type`	Mapped channel discount type from the list of Discount Types in Deliverect	string
discounts.`provider`	The issuer of the discount i.e. the one who bears the discounted amount.	Enum
discounts.`name`	The name that was given to the discount.	string
discounts.`channelDiscountCode`	The unique discount code used by the channel	string
discounts.`referenceId`	A unique number is assigned to the discount and used to reference the discount on individual items on the order.	integer
discounts.`value`	It is the flat amount of money or percentage covered by the discount which is stored with precision 2, so $1.50 -> 150	integer
discounts.`amount`	The actual amount discounted e.g. For 10% off on a $50 bill, the value will be 1000, and the amount will be 500.	integer
`tip`	A tip intended for the restaurant (see section here)	integer
`driverTip`	A tip intended for the courier (see section here)	integer
`bagFee`	Bag fee (see section here for more info)	integer
deliveryInfo	Delivery information
deliveryInfo.`packageSize`	size of the package	string
deliveryInfo.`transportType`	e.g. Bicycle, Car, motorbike ...	string
`validationId`	`validationId` returned from the ValidateDelivery endpoint. 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