{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api-explorer/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Changelog","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"changelog","__idx":0},"children":["Changelog"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"version-11-changes","__idx":1},"children":["Version 1.1 changes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following change was introduced."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentStatus"]}," field to orders so partner Apps can identify whether an order has been paid or not."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"order-entity","__idx":2},"children":["Order entity"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"New/updated field"},"children":["New/updated field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change"},"children":["Change"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change description"},"children":["Change description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional field indicating the payment status of an order."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Added to allow App partners to identify whether an order needs to be paid for. Only applicable with orders with fulfilment type of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DINE_IN"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"for-apps","__idx":3},"children":["For Apps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["App partners can optionally set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentStatus"]}," of a order as either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPEN"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLOSED"]},". If it is not specified, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentStatus"]}," field defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLOSED"]},". This field is only applicable with orders with a fulfilment type of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DINE_IN"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"for-pos-systems","__idx":4},"children":["For POS systems"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Orders with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DINE_IN"]}," fulfilment type can contain the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentStatus"]}," when fetching an order. This indicates whether the order needs to be paid or not."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"version-10-changes","__idx":5},"children":["Version 1.0 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Endpoint has been moved from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.tyro.cloud/connect/pos/orders"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.tyro.com/connect/orders"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["event.type"]}," for the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/ordering/1.0/notification-events"},"children":["Notification events"]}," have been renamed:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"0.6"},"children":["0.6"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"1.0"},"children":["1.0"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACKNOWLEDGED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_ACCEPTED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SYSTEM_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_REJECTED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["READY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_READY"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderReference"]}," field to the origin object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The allowed values of the order status field have been redefined.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BEING_PREPARED"]}," *"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["READY"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUT_FOR_DELIVERY"]}," *"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED_BY_MERCHANT"]}," *"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED_BY_CUSTOMER"]}," *"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FULFILLED"]}," *",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Fields marked with an * are optional."]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Orders that are not accepted within 2 minutes of being delivered to the POS will be automatically rejected back to the ordering partner. POS's that try to accept an order after the 2 minutes will receive an error."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifications"]}," object with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiers"]}," array. This will simplify the structure and remove the concept of additions and subtractions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["table"]},".",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["section"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order"]}," object to capture information about a table's section."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tyro Connect may in extraordinary scenarios send event notifications more than once. It was always expected that a POS will be idempotent but it was never explicitly documented that this could happen."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"draft-6-changes","__idx":6},"children":["Draft 6 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added instructions for device code authentication flow"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added instructions for websockets events"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"draft-5-changes","__idx":7},"children":["Draft 5 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rename tcOrderId to id"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace Origin field (string) with object",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The value previously stored in origin is now origin.name"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace storeId with origin.locationId"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace externalId with origin.orderId"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order Item Object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added quantity field"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated Webhook Event object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed locationId field"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added list of Allergens to modifications object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"draft-4-changes","__idx":8},"children":["Draft 4 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added Money object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added Customer object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added Discount object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added Surcharge object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added EventData object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ModificationMap to represent different types of modifications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Defined an enum for OrderStatus"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated Webhook Event object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed resource"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed id"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed uri"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added type which represents event type"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added data of type EventData which contains a payload of the event details"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated Order object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added customers to represent an array of Customer objects o Removed guest field"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed itemGroups"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated discounts to be an array of Discount objects"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated surcharges to be an array of Surcharge objects  - Updated Table object:"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed number to id"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added section to represent section table belongs to  - Updated Item object:"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated discounts to be an array of Discount objects"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated modifications to be a ModificationMap object"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"draft-3-changes","__idx":9},"children":["Draft 3 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New orders are now delivered via webhooks. This is a replacement to long polling."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order Object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added locationId"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed eventType. This is not needed since we moved away from long polling."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed subtotal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed payments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added itemGroups"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Discount is now a money object that also contains a detailed breakdown o Surcharge is now a money object that also contains a detailed breakdown"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order Item Object:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed posId to sku"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed quantity"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed surcharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Discount is now a money object that also contains a detailed breakdown o Removed total"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order Item Modification",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a field modification that can either be: ADDITION, REMOVAL or INSTRUCTION"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed discount, surcharge and total fields on the order from numbers to a money object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed unitPrice on the order item from numbers to a money object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed update order status to be a json merge patch. (switch to PATCH http verb and specific Content-Type)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed Item descriptions from per order to per item"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"draft-2-changes","__idx":10},"children":["Draft 2 changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added Item Description (max 60 characters) to the API so that it can be communicated to the kitchen with unmatched items."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added externalId so that:",{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The merchant can add this as a unique identifier to the docket if there is a chance 2 people with the same name might order around the same time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Merchants have a unique reference number for each order so that they can cross reference the order in the food order app or report provided by the app."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The discount and surcharge fields were on an item level. They have been moved to the order object level."]}]}]},"headings":[{"value":"Changelog","id":"changelog","depth":1},{"value":"Version 1.1 changes","id":"version-11-changes","depth":2},{"value":"Order entity","id":"order-entity","depth":3},{"value":"For Apps","id":"for-apps","depth":3},{"value":"For POS systems","id":"for-pos-systems","depth":3},{"value":"Version 1.0 changes","id":"version-10-changes","depth":2},{"value":"Draft 6 changes","id":"draft-6-changes","depth":2},{"value":"Draft 5 changes","id":"draft-5-changes","depth":2},{"value":"Draft 4 changes","id":"draft-4-changes","depth":2},{"value":"Draft 3 changes","id":"draft-3-changes","depth":2},{"value":"Draft 2 changes","id":"draft-2-changes","depth":2}],"frontmatter":{"seo":{"title":"Changelog"}},"lastModified":"2026-09-03T03:45:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/ordering/1.0/changelog","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}