{"_id":"582d981b0adc1123004788d1","__v":0,"user":"5809ea66629bf91900cd139f","project":"56c1e50bce02590d006091c9","category":{"_id":"582d97124b2536250038b392","project":"56c1e50bce02590d006091c9","version":"582c7058e4a4920f00ff0045","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-17T11:40:02.073Z","from_sync":false,"order":9,"slug":"version-differences","title":"Version Differences"},"parentDoc":null,"version":{"_id":"582c7058e4a4920f00ff0045","project":"56c1e50bce02590d006091c9","__v":2,"createdAt":"2016-11-16T14:42:32.468Z","releaseDate":"2016-11-16T14:42:32.468Z","categories":["582c7058e4a4920f00ff0046","582c7058e4a4920f00ff0047","582c7058e4a4920f00ff0048","582c7058e4a4920f00ff0049","582c7058e4a4920f00ff004a","582c7058e4a4920f00ff004b","582c7058e4a4920f00ff004c","582c7058e4a4920f00ff004d","582c7058e4a4920f00ff004e","582c7058e4a4920f00ff004f","582d97124b2536250038b392"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-17T11:44:27.034Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Change\",\n    \"h-1\": \"Old behaviour\",\n    \"h-2\": \"New behaviour\",\n    \"0-0\": \"New *Id* property added to [Order](doc:receive-order) contract\",\n    \"0-1\": \"The *CustomerOrderId* property (which is an integer) was used machine-readable order identification.\",\n    \"0-2\": \"The string-format *Id* property has been added as the machine-readable unique identifier for Just Eat orders.\\n\\nThe new *Id* property should be used for **all ** machine-based identification of Just Eat orders.  In order words, this property must be used in all callbacks to identify the order.\\n\\nThe *CustomerOrderId* property has been deprecated, but will be maintained in the interim for backwards compatibility.\",\n    \"1-0\": \"New *FriendlyOrderReference* property added to [Order](doc:receive-order) contract\",\n    \"1-2\": \"The *FriendlyOrderReference* property should be used as the primary human-readable order identifier.  In other words, this property is now the customer-facing reference for the order, and should be used in any UI or communication to identify the order to staff, customers, drivers or restaurants.\",\n    \"3-0\": \"New \\\"Ready for pickup\\\" event delivered via [OrderStatusUpdated](doc:receive-order-updates-from-orderconnect) callback\",\n    \"3-2\": \"An event will be communicated via the Orderconnect API, that informs the delivery partner that the food is \\\"ready for pickup\\\".  The delivery partner should receive and process this event via an endpoint - and surface this message to the driver using an appropriate mechanism (for instance, via an SMS or app notification).\",\n    \"h-3\": \"Reason for change\",\n    \"2-0\": \"New *OrderReference* property added to [Order](doc:receive-order) contract\",\n    \"2-2\": \"The OrderReference property is used to store a third party order reference.\",\n    \"1-1\": \"The *CustomerOrderId* property was used for human-readable order identification.\",\n    \"1-3\": \"This property is required as the new Id property has been designed to contain a GUID, which is unsuitable as a customer-facing order reference.\",\n    \"3-1\": \"This event was previously not communicated.\",\n    \"3-3\": \"This communication is needed to streamline the food handover process.  Specifically, many of our restaurants require drivers to wait outside the restaurant - and this event is needed to ensure that the driver knows to come inside when the food is ready for collection.\",\n    \"0-3\": \"TBD\",\n    \"2-3\": \"TBD\",\n    \"2-1\": \"N/A\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"changes-from-v20","type":"basic","title":"Changes from v2.0 to v3.0"}

Changes from v2.0 to v3.0


[block:parameters] { "data": { "h-0": "Change", "h-1": "Old behaviour", "h-2": "New behaviour", "0-0": "New *Id* property added to [Order](doc:receive-order) contract", "0-1": "The *CustomerOrderId* property (which is an integer) was used machine-readable order identification.", "0-2": "The string-format *Id* property has been added as the machine-readable unique identifier for Just Eat orders.\n\nThe new *Id* property should be used for **all ** machine-based identification of Just Eat orders. In order words, this property must be used in all callbacks to identify the order.\n\nThe *CustomerOrderId* property has been deprecated, but will be maintained in the interim for backwards compatibility.", "1-0": "New *FriendlyOrderReference* property added to [Order](doc:receive-order) contract", "1-2": "The *FriendlyOrderReference* property should be used as the primary human-readable order identifier. In other words, this property is now the customer-facing reference for the order, and should be used in any UI or communication to identify the order to staff, customers, drivers or restaurants.", "3-0": "New \"Ready for pickup\" event delivered via [OrderStatusUpdated](doc:receive-order-updates-from-orderconnect) callback", "3-2": "An event will be communicated via the Orderconnect API, that informs the delivery partner that the food is \"ready for pickup\". The delivery partner should receive and process this event via an endpoint - and surface this message to the driver using an appropriate mechanism (for instance, via an SMS or app notification).", "h-3": "Reason for change", "2-0": "New *OrderReference* property added to [Order](doc:receive-order) contract", "2-2": "The OrderReference property is used to store a third party order reference.", "1-1": "The *CustomerOrderId* property was used for human-readable order identification.", "1-3": "This property is required as the new Id property has been designed to contain a GUID, which is unsuitable as a customer-facing order reference.", "3-1": "This event was previously not communicated.", "3-3": "This communication is needed to streamline the food handover process. Specifically, many of our restaurants require drivers to wait outside the restaurant - and this event is needed to ensure that the driver knows to come inside when the food is ready for collection.", "0-3": "TBD", "2-3": "TBD", "2-1": "N/A" }, "cols": 4, "rows": 4 } [/block]