Link Search Menu Expand Document

General Options

General options allow greater levels of customization within the widget, regardless of what UI Components are enabled. This reference details the general options available, as well as provides widget examples to see the general options in application.

Introduction

General options are provided as additional query parameters to the URL of the widget and can be applied to any UI Component. Since these options are configured within the URL of the widget (via the iFrame or WebView), any changes will require a code update and deployment.

Additional options can be added per UI component. See UI Components for more details.

The following general options, sorted by category, are available for use in the widget:


Search Filters

Search filters control what parking information is shown to your users. This includes filters such as seller, location, venue, and event identifiers.

Widget Builder

Use the below tool to see how components are rendered within the widget.

Inputs
Parameter Value

Locations

Locations options can filter what results show by Arrive IDs based on the seller, destination, or venue. For a list of Arrive IDs related to your venue, parking locations, or events please reach out to your Partner Success Manager.

Parameter Type Filter by
seller-id List[Integer] Arrive Seller ID(s)
destination-location-id List[Integer] Arrive Location ID(s)
destination-venue-id Integer Arrive Venue ID
search-mobile-only Boolean Locations that do not require a printed pass

Events

Events options can filter what results show by Arrive or Ticketmaster IDs based on the event. Event filters are mainly coupled with the Events UI Components.

Parameter Type Filter by
destination-event-id Integer Arrive Event ID(s)
ticketmaster-event-id String Ticketmaster Event ID

Time

Time options can filter what results show by when and how long the user is looking to book parking. These parameters can be overridden by the Time Picker UI Component.

Parameter Type Filter by
start ISO 8601 timestamp Parking start time
end ISO 8601 timestamp Parking end time
duration ISO 8601 duration Time spent in space

Geolocation and Search Radius

Geolocation and search radius options control the location, search area, and map window.

Widget Builder

Use the below tool to see how components are rendered within the widget.

Inputs
Parameter Value

Location

Use location parameters to set the destination and automatically calculate distance to parking options.

Parameter Type Description
destination-latitude Float The latitude of the destination
destination-longitude Float The longitude of the destination

Search Radius

Use the search-radius to update the distance of which the widget will search for parking, with a maximum radius of 50 miles.

Parameter Type Description
search-radius Float Default 0.5 The radius, in miles

Zoom Level

Coupled with the Map UI Component, use the zoom level to change the level of visual zoom the map has from the inputted location. By default, the widget will set the default zoom level to encompass the nearest 10 pins.

Parameter Type Description
map-zoom Integer Mapbox Zoom

Pricing Display

Pricing display options change how pricing is shown to the user, such as currency or buyer fees.

Widget Builder

Use the below tool to see how components are rendered within the widget.

Inputs
Parameter Value

Currency

The widget supports setting default currency to USD and CAD, with the default being USD.

Setting a default currency will change what currency symbol appears throughout the widget. The following symbols appear depending on default currency:

Default/Display USD CAD
USD $ C$
CAD US$ C$

With the exception of the map pins, currency symbols are applied in all places where a pricing appears including location list cards, pre-checkout, guest checkout, and on the purchase confirmation page. Map pins will always show $ with the price.

Users will be able to checkout using the Guest Checkout UI Component regardless of whether the location’s currency is in USD or CAD.

Parameter Type Option
default-currency String The default currency to display within the widget. Options are USD (Default), and CAD

Display Savings and Fees

The widget can display savings and buyer fees throughout the experience to the user. Displaying savings will show the original price with a strikethrough within the Map and Location List UI Components, as long as drive-up pricing is available. Displaying buyer fees will display base price pre-checkout, and then base price, fees, and total on checkout.

Parameter Type Option
display-fees Boolean Displays buyer fees to user
display-savings Boolean Displays original price with a strikethrough

Pricing Access Codes

Pricing Access Codes (PACs) are private keys that surface hidden pricings. PACs can be used to create restricted pricing types for user groups such as employee parking or discounted season ticket pricings.

Parameter Type Description
pricing-access-code-exclusive Boolean Filter results to only display pricings attributed to the specified PAC(s)
pricing-access-codes List[String] Display pricings attributed to the specified PAC(s)

UI/UX

UI/UX options control how the widget displays and interacts with the user.

Widget Builder

Use the below tool to see how components are rendered within the widget.

Inputs
Parameter Value


Parameter Type View
parkwhiz-opens-in-new-tab Boolean Default True Opens ParkWhiz in a new tab upon location selection if checkout is not enabled
title-override-text String Overrides the “Book Parking Near …” text in the header. Use a space character to make the header blank

User Authentication

If you’d like your users to be logged in when using the widget, you can pass in their access token (generated via the API). This enables users to:

  • Access and use their saved payment information on checkout
  • Bypass the login screen when accessing their bookings
  • Maintain an authenticated section throughout the widget experience
Parameter Type Description
access-token String The user’s access token, used to authenticate them into their ParkWhiz Experience

Tracking and Affiliate

Tracking and affiliate options let the partner track their purchases via their own platform(s), Arrive analytics, and attribution within the affiliate portal.

Affiliate and Coupon

Use these options to attribute purchases through the widget to your partner association.

Affiliate codes must be used to track affiliate bookings and revenue in the Affiliate Portal transactional system. The affiliate code will look something similar to ‘pa-23’ or ‘5d849483’, and can be found within the Affiliate Portal.

Parameter Description
pwa Affiliate Code
coupon Coupon code

Analytics

The widget leverages standard UTM parameters for tracking. Several values are set by default and used for our own internal analytics.

Parameter Defaults
utm-campaign n/a
utm-medium If an affiliate code is passed into the widget then this will be blank, otherwise it will be set to Unpaid
utm-term Defaulted to Widget. This UTM can be passed in and it won’t be overridden.
utm-source Set to the affiliate code if the affiliate code is passed into the widget, otherwise it must be set as the URL where the widget will be embedded. Left blank if the ‘site name’ and ‘affiliate code’ are blank.
utm-content Set to the PW, StubHub, or TM venue id if a destination-venue-id exists. If there is no destination venue ID but there is a seller ID then seller ID will be passed.