Linking
The following topic describes the setup steps for to outline all of the possible URL formats that can be used to deep link guests to various parts of either Web Ordering or White Label App as part of Unified Ordering.
Linking Topics
Non-Order Mode Specific
It's possible to deep link a guest to a venue's home screen, which isn't order mode specific but is perfect jumping off point for multiple order modes or venue specific content.
Home Screen
Link to a specific Venue's home screen
It's possible to deep link to a venue's home screen so the guest can be presented with venue specific content. This deep link is great where you may want to sign post additional order modes or content that's available at this venue.
| Format | <Web Ordering URL>/#/venue/:venueID |
| Example | https://example.webordering.io/#/venue/1 |
Order Mode Specific
It's possible to deep link a guest to a specific order mode so they can start their ordering journey, streamlining their experience by removing site and sales area selection as well as populating their location such as table number or Delivery to Location identifier.
Order & Pay
Link to a specific Venue's sales area selector
For Order & Pay, it is possible to deep link to a venue's sales area selector so the guest can choose where they would like to order from. This deep link is great where there may be a large number of sales areas within a single venue, representing different outlets to order from.
| Format | <Web Ordering URL>/#/venue/:venueID/service/:serviceId/sales-areas |
| Example | https://example.webordering.io/#/venue/1/service/1/sales-areas |
Link to a specific Venue and Sales Area
For Order & Pay, it is possible to deep link to a specific venue and sales area so that the guest just needs to select their table number. This deep link is great to be placed on tables as a QR code when the tables may move around or if operationally, the guest needs to manually select their table number.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/1 |
Link to a specific Venue, Sales Area, and Table Number
Building on top of the venue and sales area specific deep link, the most seamless deep link includes the table number so the guest can simply confirm their table number and make their menu selections. This deep link is perfect to be placed on specific tables as a QR code that the guest can scan.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId/table/:tableNumber |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/1/table/12 |
Click & Collect
Link to a specific Venue's sales area selector
For Click & Collect, it is possible to deep link to a venue's sales area selector so the guest can choose where they would like to order from. This deep link is great where there may be a large number of sales areas within a single venue, representing different outlets to order from.
| Format | <Web Ordering URL>/#/venue/:venueId/service/:serviceId/sales-areas |
| Example | https://example.webordering.io/#/venue/1/service/2/sales-areas |
Link to a specific Venue and Sales Area
For Click & Collect, it is possible to deep link to a specific venue and sales area so that the guest just needs to select their desired pick up time. This deep link is great to be placed on a website or in-venue if there is a specific collection point where the guest picks up their order.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/2 |
Link to a specific Venue, Sales Area, and Timeslot
Building on top of the venue and sales area specific deep link, it is possible to also pass in a valid timeslot. This can be useful if the timeslots are being surfaced on the website.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId/time/:timeslot |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/2/time/2023-10-03T14:00 |
| Unified Ordering Enabled? | Not in scope for White Label App |
Delivery to Location
Link to a specific Venue's sales area selector
For Delivery to Location, it is possible to deep link to a venue's sales area selector so the guest can choose where they would like to order from. This deep link is great where there may be a large number of sales areas within a single venue, representing different outlets to order from.
| Format | <Web Ordering URL>/#/venue/:venueId/service/:serviceId/sales-areas |
| Example | https://example.webordering.io/#/venue/1/service/9/sales-areas |
Link to a specific Venue's sales area selector with Location
More an even more seamless guest experience, it is possible to deep link to a venue's sales area selector with the location pre-filled. This deep link is perfect for QR codes to be placed in specific guest accommodation i.e. "Order to your room"
| Format | <Web Ordering URL>/#/venue/:venueId/service/:serviceId/sales-areas?field_1<field_1>&field_2=<field_2> |
| Example | https://example.webordering.io/#/venue/1/service/9/sales-areas?field_1=Caravans&field_2=10 |
* adding only one location field (field_1 or field_2) is supported
Location values that contain a “space”, must be represented by %20 in the url
For example Caravan 10:
https://example.webordering.io/#/venue/1/service/9/sales-areas?field_1=Caravan%2010
Link to a specific Venue and Sales Area
For Delivery to Location, it is possible to deep link to a specific venue and sales area so that the guest just needs to select their desired delivery time. This deep link is great to be placed in the location they are ordering from so they have easy access.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/9 |
Link to a specific Venue and Sales Area with Location
More an even more seamless guest experience, it is possible to deep link to a specific venue and sales area with the location pre-filled. This deep link is perfect for QR codes to be placed in specific guest accommodation i.e. "Order to your room".
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId?field_1=<field_1>&field_2=<field_2> |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/9?field_1=Caravans&field_2=10 |
* adding only one location field (field_1 or field_2) is supported
Location values that contain a “space”, must be represented by %20 in the url.
For example Caravan 10:
https://example.webordering.io/#/venue/1/service/9/sales-areas?field_1=Caravan%2010
Link to a specific Venue, Sales Area, and Timeslot
Building on top of the venue and sales area specific deep link, it is possible to also pass in a valid timeslot. This can be useful if the timeslots are being surfaced on the website.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId/time/:timeslot |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/9/time/2023-10-03T14:00 |
| Unified Ordering Enabled? | Not in scope for White Label App |
Pay My Bill
Link to a specific Venue, Sales Area and Table
For Pay My Bill, it is possible to deep link to the bill of a specific table, allowing guests to see their bill immediately and proceed directly to payment.
| Format | <Web Ordering URL>/#/venue/:venueId/sales-area/:salesAreaId/service/:serviceId/table/:tablenumber** |
| Example | https://example.webordering.io/#/venue/1/sales-area/3/service/6/table/5 |
Link to a specific Venue, Sales Area, and Bill (account)
It is also possible to deep link directly to an account, utilising dynamic QR codes linked to a bill in Aztec
The configuration works slightly differently to the other Deep Linking options, as the steps need to be taken directly in Aztec.
Follow these steps to configure QR code printing on bills:
-
Click Configure Footer QR Code
-
Set the check box for Bill Footer to selected
-
Set the required QR prints size from the drop down
To support the size of the URL either medium or large must be selected -
Enter URL, following this format
Format https://example.webordering.io/#/venue/[SiteID]/sales-area/[SalesAreaID]/service/6/account/[AccountID] -
Click Edit QR Code Footer Text, add any required supporting text as required | click OK
-
Click OK
-
The URL must start with “https://”, followed by the company Web Ordering domain
-
The section after the Web Ordering domain allows Aztec to populate the QR Code that links directly to the account . “/#/venue/[SiteID]/sales-area/[SalesAreaID]/service/6/account/[AccountID]”
-
The elements in [Bold] represent dynamic fields. The IDs do not need to be populated, Aztec does this work when creating the QR code, just simply ensure the correct field names (as in the example) are entered. They can be added by using the insert button with the correct dynamic field select or typed directly into the URL
'At Table' (Pay My Bill and Order & Pay)
Link to a specific Venue, Sales Area and Table
The At Table ordering journey a previously unsupported scenario where customers can offer guests the chance to either order via Order & Pay or pay their bill from the same QR code on their table.
| Format | <Web Ordering URL>/#/at-table/venue/:venueId/sales-area/:salesAreaId/table/:tablenumber |
| Example | https://example.webordering.io#/at-table/venue/1/sales-area/2/table/3 |