Content (v1.3)

v1.3

The Content object provides structured, localized, customer-facing data that can be attached to Suppliers, Products, Rates, and individual price tiers. It is designed for display in your UI and separates rich marketing content from the core transactional fields.

Requesting Content

Content is not returned by default. To include it, add content=true to any singular GET endpoint:

xxxxxxxxxx

GET /v1.3/suppliers/{id}content=true

GET /v1.3/suppliers/{id}/products/{id}content=true

GET /v1.3/suppliers/{id}/products/{id}/rates/{id}content=true

Filtering by Language

Add the locale= parameter to return only text in specific languages. Accepts a comma-separated list of BCP 47 language tags:

xxxxxxxxxx

GET /v1.3/suppliers/{id}/products/{id}content=true&locale=en-US,es-ES,de-DE

If locale= is omitted, all available language variants are returned.

Priority Rule

When content is present in a response, its values must take priority over the equivalent standard entity fields for display purposes.

The name / internalName, title, and description fields on the main entities - Supplier, Product, Rate, and Rate Prices - are treated as standard fields, not content fields.

Suppliers who do not implement content capability may continue using these fields.

If a Supplier does use content, then they can use the content.name, content.title, and content.description fields to provide additional languages, alternative formats, or to override the values on the main entities.

LocalizedTextSet

Content fields use the LocalizedTextSet pattern to support multi-lingual and multi-format content.

LocalizedText

Represents a single text entry in a specific language and format. If a supplier provides this object, all its internal fields (text, format, and locale) are mandatory.

LocalizedTextSet

A collection of LocalizedText objects. While a set can contain multiple entries to accommodate various locales and formats, each locale + format combination must be unique within a single LocalizedTextSet. The system will reject duplicate combinations from the Supplier side.

xxxxxxxxxx

"description": [

  {

    "text": "Join us for a 3-hour kayaking tour around the Barcelona coastline.",

    "locale": "en",

    "format": "plain"

  },

  {

    "text": "Únete a nosotros para un recorrido en kayak de 3 horas por la costa de Barcelona.",

    "locale": "es",

    "format": "plain"

  }

]

Content Object Field

Categories

Help classify and organize content into easily searchable and filterable themes. They provide semantic tags that describe the type of experience, audience, or context - making it easier for resellers and end users to discover relevant content.

xxxxxxxxxx

"categories": [

  {

    "category": {

      "en-US": "Adventure",

      "es-ES": "Aventura",

      "fr-FR": "Aventure",

      "de-DE": "Abenteuer"

    }

  },

  {

    "category": {

      "en-US": "Food Tour",

      "es-ES": "Tour gastronómico",

      "fr-FR": "Visite gastronomique"

    }

  }

]

Duration

Defines how long the product or experience takes. Combines a numeric length, a time unit, and an optional localized description for display. Useful for setting customer expectations and supporting filters like "half-day", "multi-day", etc.

xxxxxxxxxx

"duration": {

    "length": 2,

    "unit": "hours",

    "description": {

      "en-US": "Estimated 2 hours of self-paced exploration.",

      "es-ES": "Aproximadamente 2 horas de exploración a tu ritmo.",

      "fr-FR": "Environ 2 heures d’exploration autonome."

    }

  },

FAQs

Stores Frequently Asked Questions and Answers relevant to the Supplier, Product, Option/Rate, or Unit/Rate Price. This helps anticipate common customer concerns and reduces friction during booking or usage.

If an FAQ is provided, the Supplier must populate both question and answer. Additionally, for a given locale, the Supplier must ensure the question and its corresponding answer use the same locale and format values.

xxxxxxxxxx

{

  "faqs": [...]

}

Features

Captures structured highlights, inclusions, exclusions, and policy-related aspects of the experience. Each item is categorized using a predefined type enum for clarity and filtering, defining how that information should be interpreted and displayed.

We currently allow duplicate feature types within the features array. This means you may include multiple entries with the same type (e.g., more than one HIGHLIGHT).

Feature Types

xxxxxxxxxx

"features": [

  {

    "type": "INCLUSION",

    "description": {

      "en-US": "Mobile app access for all participants",

      "es-ES": "Acceso a la aplicación móvil para todos los participantes",

      "fr-FR": "Accès à l'application mobile pour tous les participants"

    }

  },

  {

    "type": "HIGHLIGHT",

    "description": {

      "en-US": "Explore iconic city landmarks in a fun, gamified way",

      "es-ES": "Explora lugares emblemáticos de la ciudad de forma divertida y gamificada",

      "fr-FR": "Découvrez les monuments emblématiques de la ville de manière ludique"

    }

  },

  {

    "type": "PREBOOKING_INFORMATION",

    "description": {

      "en-US": "Players must have a smartphone with internet access",

      "es-ES": "Los jugadores deben tener un teléfono inteligente con acceso a internet",

      "fr-FR": "Les joueurs doivent avoir un smartphone avec accès à Internet"

    }

  },

  {

    "type": "REDEMPTION_INSTRUCTION",

    "description": {

      "en-US": "Start your adventure by launching the app at the designated starting point",

      "es-ES": "Inicia tu aventura abriendo la aplicación en el punto de partida designado",

      "fr-FR": "Commencez votre aventure en lançant l'application au point de départ indiqué"

    }

  },

  {

    "type": "CANCELLATION_TERM",

    "description": {

      "en-US": "Full refund available up to 24 hours before start time",

      "es-ES": "Reembolso completo disponible hasta 24 horas antes del inicio",

      "fr-FR": "Remboursement complet jusqu'à 24 heures avant le début"

    }

  }

]

Media

Provides images, videos, logos, or other rich media assets that represent the Supplier, Product, Option/Rate, or Unit/Rate Price. Media helps enhance visual storytelling and improve user engagement. Public accessibility is required from the Supplier.

Media Types

Media Relationships

Ratings

Aggregates review scores from sources like Google, TripAdvisor, Yelp, etc. This provides social proof, helping users quickly evaluate the quality and reliability of the experience.

Rating Aggregate

Rating

Reviews

Captures written customer testimonials or feedback. These reviews reflect real user sentiment and provide qualitative insights for potential buyers.

Metadata

Additional system-level metadata related to this content, such as timestamps or internal bookkeeping fields.

Use lastUpdated to determine whether a cached Content object needs to be refreshed.

Content by Entity

Not all fields are populated at every level. Content is enrichment data, not guaranteed data. Always check for the presence of each field before rendering it.

Supplier

Typical content fields: name, title, description, media (logo and gallery), ratings, reviews, faqs .

Example response (abbreviated):

Product

Typical content fields: All fields - name, title, subtitle, description, shortDescription, categories, duration, features, faqs, media, ratings, reviews

Rate

Typical content fields:

RatePrice / TravelerType

Typical content fields: name, description