Back to Olo.com

Serve URL Parameters Overview


What are URL Parameters?

URL parameters, also known as “query strings”, allow brands to apply additional information to a specific URL. Parameters are added to the end of a Serve ordering page’s URL after a ‘?’ symbol. Multiple parameters can be included when separated by the ‘&’ symbol.

Brands using Serve for their front end can add URL parameters to link guests to store menu pages with preselected settings:

  • Handoff Mode: Custom links bring guests to a page where the handoff mode is preselected

  • Order Criteria Modal: Automatically triggered to open when a guest arrives at the menu page. The order criteria modal allows guests to enter the handoff mode, time mode, and the time wanted or delivery address if applicable.

Note: Preselecting time mode using URL parameters is not currently supported, however, when the handoff mode parameter is used, the time mode will be automatically preselected using the existing process which selects the first valid option available. Our system attempts to use ‘ASAP’ first and if that is unavailable then ‘Manual Fire’ is used. If Manual Fire is unavailable, then ‘Advance’ is used. 


Understanding URL Structures

 

There are a few ways to set up URLs based on what you want your guests to see:

Handoff Mode is Preselected

Adding the following parameters to the URL will preselect the specified handoff mode on the restaurant's menu page. Note that the URL parameters do not support Handoff Labels for handoff modes.

  • Pickup: https://<brand>.olo.com/menu/<store>?handoff=counterpickup

  • Curbside pickup: https://<brand>.olo.com/menu/<store>?handoff=curbsidepickup
  • Drive-thru pickup: https://<brand>.olo.com/menu/<store>?handoff=drivethru
  • Delivery/Dispatch: https://<brand>.olo.com/menu/<store>?handoff=delivery
  • Dine-In: https://<brand>.olo.com/menu/<store>?handoff=dinein

 

Example: https://foosburgers.olo.com/menu/aurora-parker?handoff=counterpickup



Order Criteria Modal Opens

Adding the following parameter to the URL will trigger the Order Criteria modal to automatically open when a guest is linked to a store menu page.

  • Open Order Criteria Modal: https://<brand>.olo.com/menu/<store>?open-criteria=1

Example: https://foosburgers.olo.com/menu/aurora-parker?open-criteria=1



Order Criteria Modal Opens + Handoff Mode is Preselected

Parameters for handoff mode and order criteria modal can be combined. When combined, they will trigger the order criteria modal to open with the handoff mode preselected.

  • Order Criteria + Pickup: https://<brand>.olo.com/menu/<store>?open-criteria=1&handoff=counterpickup
  • Order Criteria + Curbside: https://<brand>.olo.com/menu/<store>?open-criteria=1&handoff=curbsidepickup
  • Order Criteria + Drive-thru: https://<brand>.olo.com/menu/<store>?open-criteria=1&handoff=drivethru
  • Order Criteria + Dine-In: https://<brand>.olo.com/menu/<store>?open-criteria=1&handoff=dinein

Delivery and Dispatch

There is no need to combine order criteria modal and handoff mode parameters for Delivery or Dispatch (Delivery). The address is required for Delivery and Dispatch (Delivery), so when the URL parameter is set to ‘handoff=delivery’ and the guest arrives at the store menu page, the order criteria modal will automatically display so that the guest can enter an address for the order.



Guest Experience


Handoff Mode: Delivery and Dispatch

When the URL parameter is set to ‘handoff=delivery’ and guests arrive at the store menu page, the order criteria modal will automatically display the preselected Order Type and Order Time. From here, guests can simply enter their delivery address and begin to add items to their cart.


mceclip0.png

 
If a guest cancels the modal then no handoff mode will be selected.


Handoff Mode: For all other options

When the URL parameter is set to any handoff mode other than ‘handoff=delivery’ and the guest arrives at the store menu page, the handoff mode and time mode will be preselected and the order criteria modal will not automatically display.

  

handoff=counterpickup

mceclip0.png
 

handoff=curbsidepickup

 
mceclip1.png

handoff=drivethru

mceclip2.png

 

handoff=dinein

mceclip3.png



Open Order Criteria Modal

When the URL contains the order criteria modal parameter and the guest arrives at the store menu page, they will automatically be presented with the order criteria modal. If no handoff mode has been defined by URL parameters then the channel’s default handoff mode (aka Order Type) and time mode (aka Order Time based on the process explained above) will be preselected in the modal. If a handoff mode has been defined by URL parameters then that handoff mode and time mode (based on the process explained above) will be preselected in the modal.

 

Order Criteria Modal

mceclip1.png

 

Getting started

Enabling Handoff Modes

  • In order for the URL link to work as intended, both the brand and restaurant must support the handoff modes specified in the URL parameters.
  • Olo will need to first enable channel and store settings. Keep in mind, Olo is not able to make updates to a brand’s corporate website

Example Links Using URL Parameters

A button on a brand's corporate site links to a Serve store menu page using the URL: https://foosburgers.olo.com/menu/aurora-parker

If the button needs to link to the menu page with pickup handoff mode preselected, the brand will need to ensure the following URL containing the ‘counterpickup’ handoff mode is included.

https://foosburgers.olo.com/menu/aurora-parker?handoff=counterpickup



FAQ

  • Will this enhancement work for brands with custom front-ends?
    • Custom front-ends can already dictate what happens when a user lands on the store menu page in a variety of scenarios. They do not need this enhancement. They are in full control of their experience and can allow the brands to dictate what their experience should be.

  • What happens if an invalid handoff mode value is included in the URL parameters?
    • If an invalid handoff mode value is included in the URL parameters then the handoff mode sets to the brand’s default handoff mode.

  • Will URL parameters work for linking to an Olo Serve homepage with handoff mode preselected?
    • No, creating URL parameters that enable linking to an Olo Serve home page with handoff mode preselected was out of scope. Currently, the URL parameters only work for linking to an Olo Serve store menu page.

Didn't find what you need?

Submit a request to our Help Team and someone will
get back to you shortly.

Submit a request

Copyright © 2020 Olo. All rights are reserved.