Skip to content

Vehicle Hold

The vehicle hold site plugin allows visitors to place a hold on a vehicle by placing a charge on a credit or debit card. A vehicle by default is held for 24 hours or 1 business day and the charge amount is set to $500. These values can be adjusted through the plugin's configuration.

Demo

You can view the live demo here.

Installation

This plugin has two components to it: a popup form and a trigger to open the popup form. However, only the trigger will need be installed on the page to correctly render this plugin.

Info

Please be aware that Site Plugins are installed and configured differently than Plugins. Read the site plugin reference for more information.

Placements

To install this placement, you will need the PLACEMENT_ID and the respective VEHICLE_VIN that you are installing it for. Placement IDs should be consistent across all triggers. To locate your PLACEMENT ID view it in the Orbee Platform or contact Orbee support for assistance.

It is recommended to install it for all vehicles located on both SRPs and VDPs. Place the following element below in the desired location you want the "Hold This Vehicle" button to render and fill in the variables accordingly.

<orb data-placement_id="{PLACEMENT_ID}"
     data-vin="{VEHICLE_VIN}"></orb>
If the placement was installed correctly, a "Hold This Vehicle" button will render as shown below.

Info

Want to know more about Site Plugin placements? Check out the placement reference for more information.

Danger

This Site Plugin uses Stripe to charge the vehicle hold. Once installed with a live Stripe Key, please do not test a vehicle hold. This breaks Stripe's terms of use. Please ensure that you are using a test API key in the Stripe Plugin when testing. Read more on Stripe's Services Agreement here.

Configuration

This site plugin provides the following configuration variables:

Variable Type Required Description
inventoryID uuid yes the inventory id of the account the site plugin is installed for
defaultVehicleImage string (url) no backup default image for when a vehicle in the inventory does not have an image
contactUrl string (url) no setting this url enables a link to the contact page on the vehicle error message view
loadingImage string (url) no loading image when fetching vehicle information

Methods

This plugin has no public methods.

Events

Generated

This plugin generates the following events:

Action Spec Trigger
view 
 {
    object: "vehicleHold", 
    product: "Vehicle Hold Plugin", 
    vendor: "Orbee", 
    label: "view vehicle hold trigger", 
    vin: "{VIN}", 
    inventoryID: "{UUID}"
}
 on vehicle button rendered
complete 
{
    object: "vehicleHold", 
    product: "Vehicle Hold Plugin", 
    vendor: "Orbee", 
    label: "successfully completed vehicle hold form"
}
 on successful completion of form
view 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "failed to process vehicle hold form"
}
 on failure to process card charge form
open 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "open vehicle hold form"
}
 on open vehicle hold form
close 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "close vehicle hold form"
}
 on close vehicle hold form
view 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "view agreement and disclaimer policy"
}
 on view agreement and disclaimer policy
close 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "close agreement and disclaimer policy"
}
 on close agreement and disclaimer policy
view 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "view empty vehicle hold popup"
}
 on open empty vehicle hold popup
submit 
{
    object: "vehicleHold",
    product: "Vehicle Hold Plugin",
    vendor: "Orbee",
    label: "submit vehicle hold form",
    form: {
        form: {
        vin: "",
            name: "",
            firstName: "",
            lastName: "",
            email: "",
            phone: ""    
    },
        submit: {
            text: "",
            path: "orb form[id='vehicle-hold-form'] button[id='submit']",
            node: "BUTTON",
            type: "button"    
    },
        name: "",
        valid: true
    }
}
 on submit vehicle hold form

Listening

This plugin does not listen for any events.

Dependencies

This plugin depends on the following plugins:

Stripe Plugin

Last update: 2023-04-13