Content
⚠️ Important Notice: Content Capability Update in Progress
Notice: Redeam is actively working on an updated version of this content capability to better address partner and market needs.
The current models and structures on this page will change as part of that update.
If you are currently developing against or supporting this capability, please be aware that you will need to make updates on your side once the new version is released.
We expect to release the updated version during the next quarter, and will send a formal communication to all partners once it is available.
If you have any questions or are interested in participating in the release, feel free to contact Redeam Support. Please note, however, that guidance may be limited while development is still in progress.
The Content capability allows operators to supplement their Supplier, Product, ProductOption and Unit objects with additional details, including image URLs, product / option descriptions, itinerary information, and more.
X-Capabilities: redeam/content
Objects
Descriptions of new object fields & properties provided by the Content capability.
Category
The Category object provides Suppliers with a mechanism for associating multiple Products under a common theme. For example, a tour company could provide categories for their products by the type of transport (bus, boat, or walking). A product may be a member of one or more categories.
| Field Name | Type | Required | Description |
|---|---|---|---|
title | string | No | The customer-facing display name |
subtitle | string | No | Additional information about the content which complements the title |
shortDescription | string | No | Brief description of the category |
coverImageUrl | string | No | Web address of the main thumbnail image when a customer views this category in a search result |
bannerImageUrl | string | No | Web address of a high-resolution image describing this category |
productIds | array[string] | No | List of Product identifiers associated with the Category |
Contact
| Field Name | Type | Required | Description |
|---|---|---|---|
website | string | No | Website of the service provider |
email | string | No | Email address for customer communication |
telephone | string | No | Phone number for customer communication |
address | string | No | Address of the service provider |
firstName | string | No | First name of the contact |
lastName | string | No | Last name / surname of the contact |
Destination
| Field Name | Type | Required | Description |
|---|---|---|---|
id | string | No | A unique identifier for the destination |
name | string | No | Human-readable identifier of the place or location |
country | string | No | Country code in which the destination is located |
contact | Contact | No | Contact information for the destination's service provider |
categories | array[Category] | No | The list of categories offered by a particular destination |
FAQ
| Field Name | Type | Required | Description |
|---|---|---|---|
question | string | No | A frequently asked question |
answer | string | No | Answer to the frequently asked question |
ProductImage
| Field Name | Type | Required | Description |
|---|---|---|---|
url | string | No | Web address of the product image |
title | string | No | A name or label for this image |
caption | string | No | Brief text to be displayed along with the image |
GET
/suppliers/:supplierId/products
Product
The Content capability adds the following fields to the Product object:
| Field Name | Type | Required | Description |
|---|---|---|---|
title | string | No | Customer facing display name for the product |
subtitle | string | No | Additional information about the content to complement the product title |
country | string(ISO 3166-1 alpha-2) | No | Country code in which the product is located |
shortDescription | string | No | A brief text description of the product |
description | string | No | A more detailed text or HTML string with a description of the product |
highlights | array[string] | No | A list of sales points for a customer viewing the product |
inclusions | array[string] | No | A list of amenities or features included with purchase of the product |
exclusions | array[string] | No | A list of amenities or features NOT included with purchase of the product |
redemptionInstructions | string | No | Description of guidelines for the day of product redemption |
bookingTerms | string | No | The terms and conditions under which this product can be booked |
cancellationPolicy | string | No | The terms and conditions under which the product can be cancelled |
destinations | array[Destination] | No | Location and contact information for a product |
categories | array[Category] | No | The list of categories that the product is associated with |
faqs | array[FAQ] | No | Frequently asked questions, and answers for the product |
coverImageUrl | string | No | Web address of the main thumbnail image when a customer views this product in a search result |
bannerImageUrl | string | No | Web address of a high-resolution image describing this product |
videoUrl | string | No | Web address of a video describing this product |
galleryImages | array[ProductImage] | No | A collection of images to be displayed in a gallery view for this product |
bannerImages | array[ProductImage] | No | A collection of high-resolution images (often displayed in a rotating carousel) that are displayed when a customer views this product |
ProductOption
The Content capability adds the following fields to the ProductOption object:
| Field Name | Type | Required | Description |
|---|---|---|---|
title | string | No | Customer facing display name for the product option. Example: VIP or General Admission |
subtitle | string | No | Additional information about the option to complement the title |
shortDescription | string | No | A brief text description of the product option |
duration | string | No | A text representation of how long the product option will last. Example: '2 Days' or '3 Hours' |
minTravelers | string | No | The minimum quantity (inclusive) of units required to book this option. |
maxTravelers | string | No | The maximum quantity (inclusive) of units able to book this unit option |
Unit
The Content capability adds the following fields to the Unit object:
| Field Name | Type | Required | Description |
|---|---|---|---|
title | string | No | Customer facing display name for the unit. Example: Adult or Child |
subtitle | string | No | Additional information about the unit to complement the title. Example: Ages 16+ |
minAge | integer | No | Minimum age limit of the unit |
maxAge | Integer | No | Maximum age limit of the unit |