Release notes for the Doshii API.
Version 3.4.393348029173018 (live)
Release Date: 01/11/2019
- Updated internal dependencies to improve performance
- Enhanced menu management logic to support the customisation of item tags
- Fixed issue when updating tables via POS API
- Introduced new location_hours_updated event for Apps
Version 3.4.386342022169012 (live)
Release Date: 17/10/2019
- Updated inconsistency in consumer address notes between Partner and POS APIs
- Added enumerated list of phases to the Order payload, describing the lifecycle of an order
- Added checkin status to the checkin_created and checkin_updated notification events
- Updated order_updated event to include the external order reference
- Added rewards to Loyalty Checkins and Loyalty Member Activity workflows
- Introduced new venue classifications (Winery, Brewery, Festival and Function Hall) in Onboarding API
- Updated to allow orderId on transactions payload to be Doshii ID for unlinked orders in POS API
- Improved webhook activity monitoring (added uuid to event payload)
- Introduced improved webhook retry logic
- Introduced a new UUID for each Doshii event, to improve idempotency.
- Added support for Menu Management (App-specific customised menus)
- Fixed bug in Order state machine allowing a POS to change the status of a cancelled order
- Updated PIP process to allow provider user/password credentials to be supplied
- Improved data cleanup/validation during order submission
- Updated Location unsubscibe workflow to unregister any location-specific webhooks
- Added new Doshii events for menu management notifications
- Overall performance improvements for API endpoints
Version 3.4.372326017161012 (live)
Release Date: 04/09/2019
- Updated POS API to include App's order reference in Order payload.
- Updated POS API to allow checkins to be created with status other than pending.
- Added Location local time to Location Health endpoints.
- Improved Partner API validation to further restrict access to endpoints for Apps certified for read-only logic.
- Added Loyalty Member APIs (enquiry, activity and checkins).
- Added alternate names support to Menu API.
- Updated PIP and Gift Card endpoints to enforce mandatory requirement of requestedAppId.
- Improved validation on Partner API order creation.
- Fixed issue with parsing of checkTables query parameter when creating checkins in Partner API.
- Introduced new Order@Table certification type.
- Updated Partner API authentication to use JWT bearer tokens.
Version 3.4.359311009160012 (live)
Release Date: 22/07/2019
- Added posId to Tables endpoints in POS API.
- Fixed bug in POS API where the rejection reason was not persisted on rejected checkins.
- Updated Menu API to prevent duplicate product posIds from being submitted.
- Added support for pos terminals on Order, Booking and Check-in creation.
- Added support for global options/modifiers in Menu API.
- Added ability for App-created checkins to be cancelled by creating App.
- Updated websocket authentication requirements for Apps.
- Added support for Loyalty Checkins in both POS and Partner API.
- Improved internal logging of validation errors.
- Added standard property to Location Operating Hours API endpoint.
- Added support to generate numeric item UUIDs.
- Added status and trading information to Location Health endpoints.
Version 3.4.345295007158012 (live)
Release Date: 11/06/2019
- Added timezone to POS Onboarding API.
- Updated GET /location on Partner API to return timezone information if populated.
- Fixed bug in Partner API subscription endpoint when supplying a mapped location ID.
- Added orderUri property to POS API Transactions payload.
- Fixed bug in bookings endpoint in POS API where deleted checkins were still referenced.
- Added support for location-specific webhooks in Partner API.
- Fixed intermittent 502 issue with websocket connections.
- Updated authentication requirements for Apps using websockets.
- Upgraded 3rd party libraries in Resources API.
Version 3.4.340288007148011 (live)
Release Date: 14/05/2019
- Improve meal bundle support for Food Aggregator integration.
- Updated to dispatch websocket/webhook event when location is (un)subscribed.
- Improved monitoring of websocket connections.
- Added rejectionCode and rejectionReason to transaction/payment endpoints.
- Updated payment timeouts to assign rejection details.
- Added posLocationId property to POS Onboarding API.
- Fixed issue where orderId on transaction was not reflecting posRef in POS API in certain situations.
- Upgraded 3rd party libraries.
Version 3.4.335282006143011 (live)
Release Date: 08/04/2019
- Added support for creating PIP requests without an order.
- Further improvements to menu endpoint response times.
- Fixed minor issue in transaction audit logs.
- Improved multi-threaded handling of transaction update logic.
- Fixed issue with cancelled PIP requests resulting in 504 Gateway Timeout.
- Updated to return createdByApp on POS API - GET /checkins.
- Prevent access to Partner API endpoints when not certified or only certified for Bulk Data.
- Added location capability to Onboarding API.
Version 3.4.328271002141010 (live)
Release Date: 05/03/2019
- Improved internal management of socket connections.
- Fixed validation message for duplicate booking when created by Partner API.
- Improved performance of Loyalty endpoints.
- Fixed logging issues for transactions and bookings to improve performance and storage.
- Improved filter support for App Devices on websocket connections.
- Improved App relationship management for orders.
- Initial support for message queueing of POS events.
- Introduced new Partner API endpoints to subscribe to order events for a specific order (subscribe / unsubscribe).
- Fixed issue where organisations created through onboarding API were not visible in dashboard.
- Improved performance for menu management.
- Added validation to restrict menu item prices to reject large amounts (e.g. 10000000000)
Version 3.4.320258108136001 (live)
Release Date: 22/01/2019
- Updated to dispatch transaction events to Apps linked to associated order.
- Added support for order pre-processing / price checking.
- Fixed issue where order audit log was incorrectly created for appended orders.
- Updated transaction amount and tip fields to support String or Integer.
- Updated to expose Partner API menu endpoints on read-only service.
- Improved validation on unapproved items' status within orders.
Version 3.4.313254108136029 (live)
Release Date: 19/12/2018
- Fixed logging issues for order updates to improve performance and storage.
- Updated references to remove deprecated third party dependencies.
- Added operating hours support to the location onboarding endpoints.
- Fixed bug in POST /checkins to allow consumer to be omitted.
Version 3.4.308249107134029 (live)
Release Date: 07/12/2018
- Added new resources endpoints to both POS and Partner API.
- Added support to specify location classification during POS Onboarding API.
- Fixed potential race condition in PIP requests.
- Improved validation messages for unauthorised access.
- Added validation to Venue Onboarding API to sanitise supplied address details.
- Updated surcount validation to reject decimal points in amount field when type is absolute.
- Fixed bug in certain scenarios where checkin status was not defaulting to pending.
- Prevented orphan checkins by disallowing the creation of a checkin on order update if already linked to a checkin.
- Added additional payment methods to supported list (directdeposit, cheque, alipay, wechatpay, zip and moto).
- Added support for GTIN, SKU, PLU codes in menu payload. See community post for details.
- Addressed several areas of technical debt related to the usage of third party modules.
- Removed legacy code to improve API performance.
- Fixed issue with uri property on menu payload.
Version 3.2.292232095131025 (live)
Release Date: 22/10/2018
- Updated PIP workflow to support verification data request.
- Updated PIP event dispatching to only dispatch to PIP channel if transaction created for PIP.
- Added new property, method, to transactions payload to describe the payment method used.
- Add new GiftCard endpoints for POS and Partner.
- Added new GET /apps/:id endpoint for POS.
- Fixed logic issue in GET /locations endpoint for POS.
- Updated subscription endpoints in Partner API to dispatch websocket events to POS.
- Updated Doshii heartbeats for POS to support more detailed information.
- Introduced new health_check event to allow real-time health monitoring of venue.
Version 3.2.276213092127 (live)
Release Date: 31/08/2018
- Improved performance of Partner authentication logic.
- Improved effectiveness of background websocket cleanup task.
- Updated GET /orders endpoint to support larger payload requests if accessed on the read-only endpoint and gzip compression is enabled.
- Fixed issue in POST /bookings/:bookingId/checkin to ensure checkin_created event contains valid checkin ID.
- Added support for Webhooks for Apps.
- Improved event queueing logic when handling multiple WebSocket connections.
- Added new Partner endpoint to retrieve orders for a given checkin.
- Added new Partner endpoints to retrieve specific products and surcounts from a menu.
- Updated Convert to Checkin endpoint to emit both a checkin_created and booking_updated event.
- Prevented Remove Booking if pre-order linked to reservation.
- Updated Reservation state machine to support more status transitions for POS.
- Fixed issue in Create Booking endpoint to allow other status to be supplied.
- Removed Doshii v2 endpoints and support.
Version 3.1.266187083117 (live)
Release Date: 10/07/2018
- Upgraded all technical dependencies, resulting in improved performance.
- Fixed issue where POS could not submit surcounts with descriptions.
- Added support to queue up to 10 minutes worth of websocket events, to be replayed on reconnection.
- Added compression/gzip support across POS and Partner API.
- Update GET /apps endpoint to only return subscribed apps.
Version 3.1.255165075107 (live)
Release Date: 29/05/2018
- Support POS-Initiated Payments (PIP).
- Added support for redemption codes as payment.
- Added support for the doshii-terminal-id http header.
- Added x-doshii-api-version to response header.
- Applied several performance improvements and module dependency updates.
- Added uri to the POS terminal payloads (see GET /terminals).
- Fixed posRef value on transaction_updated event.
- Fixed issue with uri in Tables payload for POS API (see GET /tables).
- Improved support for gzip/compressed menu payloads (request and response).
- Fixed issue that prevented a pending transaction from being cancelled.
- Improved validation messages for all endpoints.
- Updated to allow transactions to be created by POS during order creation.
- Added filter criteria to GET /tables endpoints for both POS and Apps.
- DELETE /table/:tableName now returns a 200 on success with no payload.
- Improve validation for Apps when linking a new order to an existing checkin.
Version 3.1.225127049097 (live)
Release Date: 19/04/2018
- Support pre-orders to be created and linked to a reservation booking.
- Added posCreatedAt property to order payload.
Version 3.0.219115043095 (live)
Release Date: 27/03/2018
- Added support on the GET /orders endpoint to filter orders by posRef and externalOrderRef.
- Fixed issue where bookingId was not present on a nested checkin.
- GET /tables/:tableName/orders updated to only return accepted orders by default.
- Updated checkin logic to ensure completedAt is set when appropriate.
- Added internal improvements to monitoring
- Added hashed location details to all relevant websocket events
Version 3.0.211108042095 (live)
Release Date: 19/03/2018
- Fixed websocket event uris for linked and unlinked orders
- Fixed websocket event uris for tables
Release notes for the Doshii Dashboard.
Version 1.13.2 build #757
Release Date: 01/11/2019
- Added menu image support to the Menu Management feature
- Fixed display issue where operating hours were outside of standard time increments
- Display App subscription date on Venue Health page
Version 1.13.1 build #751
Release Date: 17/10/2019
- Added Menu Management support (allow App-specific customised menus)
- Added POS vendor information against venues in Organisation Details page
- Added capability to export menu from Dashboard
- Improved alerting workflow for POS vendors
- Updated internal dependencies for improved performance
Version 1.12.0 build #734
Release Date: 30/09/2019
- Updated Dashboard to have URLs and IDs that more closely align with the API
- Introduced new venue classifications (Winery, Brewery, Festival and Function Hall)
- Fixed issue when invoking venue health checks for Bulk Data Apps
- Fixed bug in Create User workflow related to invalid organisation
- Introduced webhook activity page to monitor webhook health
- Updated metrics to use venue's local timezone
- Improved support for updating user profiles prior to activation
- Added support for rewards on loyalty checkins and loyalty member activity
Version 1.11.7 build #721
Release Date: 04/09/2019
- Updated sample menu payloads to include additional properties.
- Added support for simulating Loyalty Member API endpoints (enquiry, activity and checkins).
- Added public website property to Apps, Venues and POS Vendors.
- Included venue status in search display.
- Fixed bug in Order Details page when invoking Check API while viewing as App.
- Improved security monitoring.
- Updated venue merging functionality to consider new membership workflows.
- Fixed bug during App creation when certain properties are enabled.
- Added support for the new Order@Table certification type.
- Fixed bug during Update Payments process where Payment apps were incorrectly displayed.
- Updated to ensure email address checks are case-insensitive.
- Added Table Spend metrics to both App and Venue health pages.
Version 1.11.6 build #696
Release Date: 16/08/2019
- Updated sample payment payloads to include additional properties.
- Fixed issue where some venue properties were not being updated correctly.
Version 1.11.5 build #694
Release Date: 09/08/2019
- Removed heartbeat monitoring from Apps pages if App does not support websockets.
- Updated trial account sign-up process to be more streamlined.
- Fixed bug in menu export to include bundled items.
- Added support for alternate names for venues.
- Added support for simulating Loyalty Checkins via Dashboard.
- Added menu global options to Menu page.
- Improved venue searching for Apps.
- Added capability to edit venue operating hours.
- Updated to display venue location time to Venue details and health pages.
- Updated to display whether or not venue is currently trading, based on operating hours.
- Fixed intermittent issue when updating venues.
- Improved announcements support.
- Add support to invoke location health API from App Health page for each venue.
- Added metrics to App Health page.
- Fixed validation bug when updating longitude and latitude for venues.
- Fixed issue preventing user's from updating their own profile.
- Display tips on Order Details page.
- Provided ability to change metrics period (7, 14 or 30 days).
Version 1.11.4 build #665
Release Date: 24/06/2019
- Added ability to sort orders by posRef on Venue Health page.
- Updated websocket authentication requirements.
- Fixed bug that was preventing Apps from being created, due to missing information.
- Improved validation logic for create and update forms.
- Added POS Terminal support to Order and Checkin creation dialogs.
- Added subscription counts to App and POS lists.
- Added POS ID to Venue Table pages.
- Fixed duplicate order bug in Order lists for PIP Apps.
- Improved performance of analytics/metrics.
- Fixed bug during App creation in the sandbox environment.
- Improved realtime event information for app and venue subscriptions.
Version 1.11.3 build #643
Release Date: 31/05/2019
- Added support for location-specific webhooks.
- Improved handling of POS vendor maintenance.
- Updated Order Details page to display rejection code and reasons (if supplied) for rejected payments.
- Added support to invoke external health status for orders created by third party Apps.
- Updated transaction amount display to show in $.
- Added ability to sort orders by POS ref or Updated date in Venue health page.
Version 1.11.2 build #631
Release Date: 23/04/2019
- Fixed issue when merging venues with duplicate order IDs.
- Updated menu item ID filtering to perform partial matching.
- Improved realtime events for Apps outside of user's organisation.
- Fixed bug on App Health page when filtering venues by subscribed.
- Updated third party dependencies.
- Fixed regression bug when updating a location.
- Updated to prevent duplicate POS vendor names.
- Added filtering support on venue alerts for POS vendors.
- Added ability to filter on partial menu item posId match.
- Improved PIP simulation support where Payment Apps can be selected during request.
- Introduced timezone information for venues
Version 1.11.1 build #613
Release Date: 01/04/2019
- Improved security and permissions based on user's organisation.
- Introduced venue status.
Version 1.11.0 build #605
Release Date: 20/03/2019
- Added links to OpenAPI documentation for both POS and App APIs.
- Fixed issue during creation of test venues related to generation of sample menu.
- Improved workflow of trial signup process.
- Modified login page to allow signup.
- Updated terms of service page to require acknowledgement of terms.
- Updated venue alerts list to display App subscriptions.
- Provided ability to CTRL/Command click action buttons to open a new browser tab/window.
- Added ability to change Order Details view based on App or Venue.
- Fixed layout issue on Organisation Details page for users.
- Improved performance of App Health page for Orders.
- Added ability to indicate capability support for venue and POS system.
Version 1.10.8 build #588
Release Date: 12/03/2019
- Updated Order Details page to display transaction surcounts.
- Fixed issue when filtering menu items.
- Fixed issue when merging venues.
Version 1.10.7 build #582
Release Date: 01/03/2019
- Improvements to menu paging on Venue Menu Details page.
- Added sorting support in Menu Details page.
- Updated venue lists to display last order details.
- Included alerts for when a venue has not submitted an order in the last 5 days.
- Added support for PIP Apps to view orders they have managed payments for.
Version 1.10.6 build #571
Release Date: 05/02/2019
- Added support for the simulation of preprocessing orders.
- Added support for the simulation of heartbeats from a venue.
- Added the ability for authorised personnel to merge venues.
- Enhanced order searching to filter by venue
- Added ability to access health page directly from search -
- Enhanced the Order Activity charts to provide week-by-week comparison.
- Updated to display terms of service on login page.
- Updated to display the App ID on the App details page.
- Updated to display registered App Devices on the App details page.
- Improvements to UI on mobile devices.
Version 1.10.5 build #551
Release Date: 22/01/2019
- Added support for accepting/rejecting orders with unapproved items in sandbox environment.
- Added support to append items to an existing order in sandbox environment.
- Added support for announcements.
- Minor improvements to handling API calls from Dashboard.
Version 1.10.4 build #547
Release Date: 11/01/2019
- Added support for giftcard activation and enquiry via sandbox dashboard.
- Fixed issue where order acceptance via Order Details page did not handle unapprovedItems.
- Added capability for venues to block subscribed Apps.
- Updated to display status on unapproved items on Order Details page.
- Fixed issue where submitting payments as App intermittently failed.
- Fixed JSON validation warnings when submitting payments.
Version 1.10.3 build #540
Release Date: 31/12/2018
- Fixed issues when creating test venues during organisation registration.
- Improved logic when accepting/rejecting orders from Order details page.
- Improved support for troubleshooting user access issues.
- Fixed issue when creating new Apps in the sandbox environment.
Version 1.10.2 build #530
Release Date: 14/12/2018
- Improved performance of Order Details page when order has experienced a large number of amendments.
Version 1.10.1 build #529
Release Date: 07/12/2018
- Added support for the Data API service channel.
- Fixed bug in venue alerts display.
- Fixed bug in update checkin logic when ref property is undefined.
- Updated sample menu process to generate a wider assortment of menu items.
- Improved performance of venue health page.
- Added Data Aggregation Requests to App health page.
- Improved error message when attempting to login prior to activating your account.
- Internal performance improvements on back-end data access.
- Fixed bug when removing all Types from an App.
- Fixed issue where transaction invoice was not being displayed in Order Details page.
- Updated default settings for App Types when new App created.
- Altered Update page to redirect to calling page rather than always back to Details page.
- Improved App Health page to only display information relevant to certified service channels.
Version 1.10.0 build #506
Release Date: 19/11/2018
- Added support for POS terminals.
- Improved troubleshooting and support functionality for Doshii support team.
- Minor enhancement to ignore leading or trailing spaces when searching for orders.
- Added venue metrics to Venue health page.
- Performance improvements with internal cache access.
- Added support for checkin updates from Order details page in sandbox environment.
- Fixed venue filtering bug in App health page.
Version 1.9.9 build #498
Release Date: 23/10/2018
- Improved onboarding process to automatically generate test Apps and Venues for trial accounts.
- Added ability to view transaction audit logs from Order Details page.
- Updated order:<order id> search logic to return venue name in results.
- Added heartbeat monitoring for active venues.
- Fixed issue when attempting to submit an order for a venue that does not have a menu.
- Fixed phone number mapping in Dashboard compared to Onboarding API.
- Improved ability to copy JSON payloads from API requests.
- Added heartbeat history to venue health pages for monitored venues.
- Fixed filtering logic on POS list page.
Version 1.9.8 build #485
Release Date: 12/10/2018
- Updated to ensure the new app_subscribed event is dispatched when a subscription is performed via the dashboard.
- Added support for the new heartbeat messages.
- Added support to submit a health check request from the dashboard for a venue.
- Fixed validation issue with longitude and latitude properties for a venue.
- Added new Gift Cards service channel to the App details page.
- Included additional special characters in venue name validation.
- Updated order reject process to also reject any pending transactions.
- Improve menu filtering and viewing on Venue Menu Details page.
- Provide link of ordered item to menu item on Order Details page.
Version 1.9.7 build #478
Release Date: 10/09/2018
- Added ability to amend single menu item in sandbox environment.
- Added full PIP simulation support via Order Details page.
- Display Order amounts on Order Details page.
- Updated Sample Order generation in sandbox environment to be based on venue's current menu.
- Updated display for App Types for Apps that are certified for multiple App Types.
- Improved phone number validation to support a much larger list of valid phone number formats.
- Fixed issue during App/Venue subscription when no venue details were provided.
- Fixed minor security concerns.
Version 1.9.6 build #460
Release Date: 27/08/2018
- Updated App Details page to display subscribed webhooks.
- Fixed permissions issue related to submitting orders via dashboard in sandbox.
Version 1.9.5 build #459
Release Date: 07/08/2018
- Added new venue status of Subscribed, to filter venues by those that are subscribed to an App.
- Added POS Vendor information on Venue list found on App Health pages.
Version 1.9.4 build #446
Release Date: 31/07/2018
- Added ability to create and update orders using the Doshii API.
- Implemented paging of orders on the App and Venue health pages (last 1,000 orders).
- Introduced real-time event monitoring to App health page.
- Updated order details to display additional payment information.
- Updated permissions to allow Apps to view tables for venues they are subscribed to.
Version 1.9.3 build #441
Release Date: 12/07/2018
- Updated to display checkins and reservations for venue tables.
- Added ability to create and update checkins.
- Display user's organisation in user lists.
- Fixed issue in Organisation registration process when inviting existing users.
- Added POS Vendor details in App Venue Subscriptions list.
- Fixed sorting issue when sorting by organisation on POS list page.
- Added Venue count on POS list page.
Version 1.9.2 build #438
Release Date: 05/07/2018
- Added more filtering and sorting logic to dashboard lists.
- Added paging logic to venue tables.
- Added image support for POS and venues.
- Improved UI for filtering and sorting.
- Added additional information to venue order lists.
- Display expired invitations on user profile page.
- Improved list paging performance.
- Added support for venue ID mapping.
- Added support contact details for Apps.
- Display longitude and latitude of venue, with call out to Google maps.
- Display role and lastLogin on users list page.
Version 1.9.1 build #418
Release Date: 25/06/2018
- Updated the order details page to display bundled items.
- Updated venue health page to display all subscribed Apps.
Version 1.9.0 build #416
Release Date: 20/06/2018
- Provide links to the Doshii Support & Guide.
- Improvements to UX around failing API calls.
- Add support for searching for orders by id, posRef and externalOrderRef. Use the order: prefix in your search (e.g. order:1234)
- Improvements to tooltips.
- Added activity logs to order details page
- Improved data sanitisation during organisation and venue creation.
- Added table sorting and filtering to the majority of list pages.
- Ability to merge organisations.
Version 1.8.7 build #388
Release Date: 29/05/2018
- Display all date/time fields in local timezone (rather than UTC).
- Internal changes to improve billing metrics.
Version 1.8.6 build #383
Release Date: 29/05/2018
- Improved performance of health page loads.
- Included additional activity metrics on health pages.
- Embedded Terms of Service information within Dashboard.
- Added support for gravatar profile images.
Version 1.8.5 build #377
Release Date: 25/05/2018
- Improved security checks in user creation process.
Version 1.8.4 build #375
Release Date: 23/05/2018
- Updated copy logic of App, POS and venue secrets.
- Improved handling of unknown users.
Version 1.8.3 build #372
Release Date: 15/05/2018
- Added new Registered status filter to venues. This filter will show venues that have been registered but have never received an order.
- Added venue trending charts to POS details page.
- Improved venue trend charts to include connected vs registered.
Version 1.8.2 build #369
Release Date: 11/05/2018
- Removed mandatory requirements of phone number on user profile.
- Updated to display posCreatedAt on order details page.
- Fixed issue with validation message showing incorrectly.
- Updated to better handle scenario for legacy users with no roles assigned.
- Added ability to toggle alert generation when no heartbeats have arrived for a venue/app.
Version 1.8.1 build #364
Release Date: 04/05/2018
- Added support for paging menu information.
Version 1.8.0 build #360
Release Date: 03/05/2018
- Added support to create or update a menu for a venue via the Menu page for a given venue.
- Improve validation when creating venues, Apps or POS around missing organisation or vendor details.
- Improve venue name sanitisation to support additional special characters: hyphens (-), ampersands (&) and periods (.)
- Improved support for registering Apps with no active service channels.
- Updated App details page to display API version being used by the App.
- Fixed issue related to user invitations for users that are later deleted.
- Several performance improvements
Version 1.7.9 build #348
Release Date: 09/04/2018
- Fixed issue related to organisation hashed Id.
Version 1.7.8 build #346
Release Date: 06/04/2018
- Introduced venue classifications.