Configure MLB Ballpark Deep Links for Shift4 Venue

Description: Learn to create and configure MLB Ballpark deep links for the Shift4 Venue mobile ordering experience, including URL construction, encoding, and optional QR code setup.

Construct the OrderNext URL

The OrderNext URL is made up of three parts that are joined together.

1. Build the base URL using your organization key:
   https://<org_key>.principal.prd.api.vnops.net/
2. Append the redirect path with your instance name:
   redirect?instance=<instance_name>
3. Append the optional menu redirect path:
   redirect=<menu-path-from-OrderNext-URL>
   This value can be copied directly from the end of an existing OrderNext URL. For example, from:
   https://nationals.ordernext.com/a4dacd83-b5d0-495f-b175-d6315b1fb349/menu/40593a31-f5ed-46c5-a681-be2fff0074c4
   the redirect value is:
   a4dacd83-b5d0-495f-b175-d6315b1fb349/menu/40593a31-f5ed-46c5-a681-be2fff0074c4
4. Concatenate all three parts. The result should resemble:
   https://nationals.principal.prd.api.vnops.net/redirect?instance=nationals&redirect=a4dacd83-b5d0-495f-b175-d6315b1fb349/menu/40593a31-f5ed-46c5-a681-be2fff0074c4

Note: Contact Shift4 Venue support if you are unsure of your organization key. The organization key is not always the same as the OrderNext instance name.

Encode the URL

1. Use a URL encoding tool such as Meyer Web Dencoder to encode the full OrderNext URL constructed in the previous section.
2. The encoded result should resemble:
   https%3A%2F%2Fnationals.principal.prd.api.vnops.net%2Fredirect%3Finstance%3Dnationals%26redirect%3Da4dacd83-b5d0-495f-b175-d6315b1fb349%2Fmenu%2F40593a31-f5ed-46c5-a681-be2fff0074c4

Create the MLB Ballpark Deep Link

1. Prepend the following prefix to the encoded URL:
   ballpark://webview?dataTier=1&venueID=<venue_id>&url=
2. The completed deep link should resemble:
   ballpark://webview?dataTier=1&venueID=3309&url=https%3A%2F%2Fnationals.principal.prd.api.vnops.net%2Fredirect%3Finstance%3Dnationals%26redirect%3Da4dacd83-b5d0-495f-b175-d6315b1fb349%2Fmenu%2F40593a31-f5ed-46c5-a681-be2fff0074c4

Note: MLB provides the venue ID value. Contact your MLB representative to obtain the correct venue ID for your organization.

Coordinate With MLB for the Branch URL

1. Provide the completed deep link to your MLB representative to configure a Branch URL.
2. The Branch URL directs users to the MLB Ballpark app deep link when the app is installed on their device.
3. If the app is not installed, the Branch URL redirects users to an MLB page with app details and installation instructions.

Set Up a Short URL and QR Code

Note: This step is optional but recommended, particularly for physical signage.

1. Contact Shift4 Venue to request a short URL and QR code for the Branch URL.
2. If the Branch URL changes in the future, Shift4 Venue can update the destination without requiring a new short URL or QR code, eliminating the need to reprint signage.