Roomvo

📘

This integration is currently in beta. Contact your MetaRouter support team to get started.

What Is Roomvo?

Roomvo is a room visualization platform that lets shoppers see products such as flooring, tile, and paint rendered in their own space before making a purchase. Retailers and manufacturers embed the Roomvo visualizer on their websites, allowing customers to upload a photo of a room and preview how different products will look in it. By helping shoppers make more confident buying decisions, Roomvo supports higher engagement and conversion for home improvement and décor brands. The platform also gives retailers insight into how visualizer usage relates to completed purchases.


Product Type: Room Visualization
Integration Type: Starter Kit
Event Source Type: Web
Event Scope: Conversion Events Only


Capabilities

  • Sends completed order events to Roomvo, including order totals, currency, and the individual products purchased.
  • Matches each order back to the visitor's Roomvo session, so purchases can be attributed to visualizer usage.
  • Ensures only orders with complete product details are sent to Roomvo.
  • Standardizes currency codes and defaults missing product quantities to 1.
  • Batches multiple orders into a single request for efficient delivery to Roomvo.

Considerations

  • The vendor ID must match the vendor ID Roomvo has on file for your account.
  • If no matching visitor ID is found, the anonymous ID is sent instead.
  • The category must match the product category configured in your Roomvo account.

Limitations

  • An order must include at least one product to be sent. Orders with no product details are not forwarded.

Identity Sync

  • Sync Available: Yes
  • Required for Starter Kit: Recommended
  • Prerequisites: Roomvo visualizer present on the site to set the visitor cookie
  • Documentation: See Roomvo Sync Documentation

Sync Details

  • Captures the Roomvo visitor identifier from a first-party cookie.
  • Stores the visitor identifier in first-party storage for the configured cookie lifetime.
  • Appends the visitor identifier to server-side events so orders can be matched to a Roomvo session.
  • Without this sync, orders fall back to the anonymous ID for matching.

Starter Kit Setup Guide

1. Deploy the Roomvo Sync

  • To collect the sync values (e.g., ffvisitorids), you must implement a Roomvo ID sync. Refer to the following documentation to complete the setup: Roomvo - ID Sync Guide.

2. Gather Credentials

  • This integration requires a refresh token and your vendor ID, both issued by Roomvo. Reach out to your Roomvo account representative to request them for your account.
    • Refresh Token: Provided by Roomvo; used to authenticate requests on your behalf.
    • Vendor ID: Your unique vendor identifier in Roomvo's system.
    • Category: The product category (e.g., flooring) used to match visualizer sessions to orders. Must match the category configured in your Roomvo account.

3. Add a Roomvo Integration

  • From the integration library, add a Roomvo integration. Then, fill out the Connection Parameters:
Connection ParameterDescription
REFRESH_TOKENRefresh token issued by Roomvo, used to obtain an access token for authenticating requests.
VENDORYour unique vendor identifier in Roomvo's system.

4. Configure Event Mapping

  • MetaRouter provides all of the event mappings that Roomvo integrations typically require. You may add custom events, parameters, or mappings in accordance with Roomvo's API documentation.

5. Deploy to Pipeline

  • In the Pipelines tab, add your Roomvo integration.
  • Select the correct integration revision.
  • Click Add Integration to finalize deployment.

Event Mappings

Event Specific

This integration does not define global mappings; all mappings are applied at the event level.

Order Completed

Output KeyDescriptionExpected Input
totalFloat: Total value of the order.properties.total
currencyString: Currency code, converted to uppercase.properties.currency
transactionString: Order or transaction identifier.properties.order_id
vendorString: Vendor identifier configured for your Roomvo account.$$VENDOR$$
visitorString: Roomvo visitor ID matched by category, or the anonymous ID when no match is found.Expression – resolves from context.providers.roomvo.ffvisitorids; falls back to anonymousId
productsArray: Purchased products, each with sku, price, and quantity (defaults to 1).Expression – maps properties.products

Required & Recommended Identifiers

These identifiers must be mapped to Roomvo in order for successful user matching to occur. Without these IDs, any events sent to Roomvo may not be accurately reflected in reporting.

AttributeExampleSync Injector Required?
ffvisitorids Recommended69622469519048fcac64c4febe65df3dYes
anonymousIdb171a9b06ce011ecafcd1b209be8601bNo

Integration Validation

Please coordinate with your Roomvo account representative to confirm that order events are being received and processed correctly on their backend.