Skip to main content

Widget Redesign: API and Widget Parameter Updates

Updated this week

With the upcoming widget redesign release, we are introducing improvements to product presentation, categories, and widget flexibility. Most changes are backward-compatible, but we have outlined the required actions below.

Data migrations will handle legacy fields automatically - no manual work is needed there.


1. “/activities” Endpoint Changes

We have enhanced how our products display highlights, itineraries, and inclusions/exclusions.

  • New list fields added (replacing plain text fields):

    • highlights_list (array of strings)

    • inclusions_list (array of strings)

    • itinerary_list (array of strings

    • exclusions_list (array of strings, brand new)

  • Legacy text fields (highlights, inclusions, itinerary) remain for backward compatibility.

  • Migration: Existing data from old fields will auto-migrate to the new lists.

  • Post-release: New/updated activities will use only the list fields.

Actions: We recommend starting using the new fields through your API connections, since any new updates will only affect the new list fields and not the legacy text fields.


2. Categories (/activity-groups Endpoint)

Activity groups are flattening for simpler structure - no more nested children's activity groups.

  • Children field is now deprecated (still present but ignore it going forward).

  • Activities from child groups move directly to the parent group's activity list.

    • Example: A group with 3 children (each with 20 unique activities) now has 60 activities in its activity_list.

  • New activity groups won't have children at all.

Actions: Update your code to use activity_list instead of children. Please test post-release.


3. Widget URL Parameters

New options for standalone mode, multi-products, and tab control. All existing widgets remain functional.

  • standalone (default: false)

    • Makes widget full-screen (no X button) - ideal for external/shared URLs.

    • Recommended: Add standalone=true to current external widget URLs before release, to ensure a better user experience.

  • activity_id (new item, now supports multiples, e.g., activity_id=123,456)

    • Creates multi-product widgets.

    • No action is needed.

  • category_id (now supports multiples, e.g., category_id=1,2)

    • Creates multi-product widgets.

    • Shows products from all listed categories.

    • No action is needed.

New Parameters:

  • Show_products & show_transfers (default: true): Redesigned widget will have 2 separate tabs for things to do (all product types other than transfers) and transfers.

    • Set to false to hide the respective tabs.

Actions:

  • Product-only widgets (no transfers): Add show_transfers=false.

  • Transfer-only widgets: Add show_products=false.

  • Without this, unused tabs appear empty - update now to avoid guest confusion.

  • This only affects multi-product widgets; product widgets are not affected.


4. Other Widget URL Parameters

Other widget URL parameters to define the booking button text and background color and the product information language.

  • booking button text: Define the exact text of the booking button within the code (e.g., BOOK NOW).

  • booking button background color: Define the exact color inside the existing style attribute within the code (e.g., background-color:#97843e;).

  • product information language: Define the language of the product content within the code (e.g., data-lang="en").


Next Steps

  • Before release: Widget parameter updates (especially show_transfers=false & show_products=false).

  • After release: Test API endpoints and migrate to new list fields where possible.

Did this answer your question?