Content (In Member Review)
Adds extra content fields to OCTO Core object schemas on select endpoints to provide detailed descriptive information about supplier, products, options, units, booking, etc.
This new proposed capability is currently undergoing Specification Committee and Member reviews.
We'd love to hear your feedback on this draft! Use #content-capability-development channel on OCTO Slack, or comment on on the draft here:
https://docs.google.com/spreadsheets/d/12bAjNcmW92ZIsghLNfDlpuZALzO7GLkOODWrocu3sic/edit?usp=sharing
To use this capability add octo/content
to your Octo-Capabilities
header.
This capability extends the Supplier, Product, Option, Unit, Availability and Booking schemas to add additional descriptive content that can be used to populate product listings as well as for various for other use cases that require this information.
Localization
Since suppliers and their systems may offer content in different languages, this content capability supports localization through Accept-Language
request header as well as Content-Language
and Available-Languages
response headers as described below.
Request Headers
-
Accept-Language
Optional
This optional request header allows to specify preferred languages for content in the response.
Response Headers
-
Content-Language
Required with octo/content
This header indicates the language of the content fields provided in the response.
To retrieve content in multiple languages, separate requests must be made.
Available-Languages
This header lists all the languages in which content is available, helping clients understand available language options without additional requests.
Also following BCP 47 standards (e.g., en-US
, fr-CA
, es-ES
),
This header is commonly used in APIs, but is non-standard HTTP header.
Additional Content Fields
Content capability enriches existing OCTO Core Supplier, Product, Option, Unit, Availability and Booking objects with additional information listed below when octo/content
is added to the Octo-Capabilities
header of the request of any OCTO Core endpoint containing this object, given that the supplier system supports this capability.
Please select a tab below to view exact fields and details for each object:
Supplier object will be extended with additional information about the supplier as indicated below.
Please note introduction of an optional venue
concept. venue
object, whose fields mostly repeat supplier
ones, is designed for larger suppliers that operate multiple locations, venues, brands or destinations that may need to have different more specific supplier content information, as show in example below.
Working draft in Google Sheets: https://docs.google.com/spreadsheets/d/12bAjNcmW92ZIsghLNfDlpuZALzO7GLkOODWrocu3sic/edit?gid=478235837#gid=478235837
legalName
string | null
The official registered name of the company's entity or organization, as recognized by legal or governmental authorities. This name is typically used in formal or legal contexts, such as contracts or regulatory filings. It provides an authoritative identifier for the supplier's legal status. This field can be null if the legal name is unavailable or not recorded in the supplier system.
shortDescription
string | null
A customer-facing brief summary or description of the supplier, designed to provide a concise overview of the business and its key characteristics. This field is intended to give end customers a quick understanding of the supplier's purpose, services, or unique offerings. It should highlight notable attributes in a professional and engaging manner to attract and inform customers. The recommended length is 150-300 characters to ensure clarity and brevity. This field can be null if a short description is not available in the system.
contact.addressLine1
string | null
The primary address line, typically used for the street address, P.O. box, or company name. This field is equivalent to address but structured separately for where this level of detail is needed. It can be null if no address information is provided.
contact.addressLine2
string | null
The secondary address line for additional details, such as apartment numbers, suites, units, or building names. This field is equivalent to part of contact.address in OCTO Core but structured separately for where this level of detail is needed. It can be null if not applicable.
contact.city
string | null
The name of the city or locality associated with the address. This value can be null if the city is not available or not required.
contact.stateProvinceRegion
string | null
The state, province, or region associated with the address. This field is equivalent to part of address but structured separately for cases where this information is critical. It can be null if such administrative divisions are not applicable.
contact.postalCode
string | null
The postal code or ZIP code for the address. This field is equivalent to part of address but structured separately for postal-specific details.
contact.country
string | null (ISO 3166-1 alpha-2)
The two-letter country code for the address, formatted in ISO 3166-1 alpha-2 (e.g., "US" for the United States). This field is equivalent to part of address but structured separately for identifying the country. It can be null if not provided.
contact.latitude
float | null (decimal degrees)
The latitude of the location, expressed in decimal degrees. This geospatial coordinate is structured separately for more precise geographic pinpointing.
contact.longitude
float | null (decimal degrees)
The longitude of the location, expressed in decimal degrees. Similar to latitude, this field provides geospatial data that complements address.
contact.externalPlatformLocations[]
array<object> | null (externalPlatformLocation object)
A list of unique identifiers for the location from external platforms, such as Google Maps, Apple Maps, Tripadvisor, or other mapping and location services. This field is an optional extension to address field providing external references for mapping, third-party integrations, or enhanced location visibility. These references help integrate the supplier’s location with third-party systems for seamless navigation or cross-platform mapping. It may be null if no identifiers exist in the supplier's system.
contact.externalPlatformLocations[].type
string (enum: GOOGLE_PLACE_ID, APPLE_PLACE_ID, TRIPADVISOR_LOCATION_ID, YELP_PLACE_ID, FACEBOOK_PLACE_ID, FOURSQUARE_PLACE_ID, BAIDU_PLACE_ID, AMAP_PLACE_ID, OTHER)
The type of external platform providing the location identifier. Possible values include: GOOGLE_PLACE_ID: A unique identifier for a location on Google Maps, retrievable via the Google Maps API. APPLE_PLACE_ID: A unique identifier for a location in Apple Maps, retrievable via Apple’s Maps API. TRIPADVISOR_LOCATION_ID: An identifier for a location on Tripadvisor, used to link reviews, ratings, or other data from the Tripadvisor Content API. YELP_PLACE_ID: A unique identifier for a business or location on Yelp, often tied to user reviews and ratings. FACEBOOK_PLACE_ID: An identifier for a location on Facebook, linking to the business’s page or check-in location. FOURSQUARE_PLACE_ID: A unique identifier for a venue or location in Foursquare’s database. BAIDU_PLACE_ID: An identifier for a location in Baidu Maps, primarily used in China. AMAP_PLACE_ID: A unique identifier for a location in Amap (Gaode Maps), another popular mapping service in China. OTHER: A generic option for identifiers from platforms not explicitly listed.
string
The unique identifier assigned to the supplier’s location by the specified platform. Each type corresponds to a specific kind of ID: GOOGLE_PLACE_ID: The unique place_id from Google Maps, retrievable through the Google Places API. APPLE_PLACE_ID: The place.id provided by Apple Maps API for a location. TRIPADVISOR_LOCATION_ID: The location_id from the Tripadvisor Content API, linking to reviews and other Tripadvisor data. YELP_PLACE_ID: The unique ID for a business location on Yelp. FACEBOOK_PLACE_ID: The page or place ID used by Facebook for location check-ins or business pages. FOURSQUARE_PLACE_ID: The venue ID from Foursquare’s API, providing location-specific data. BAIDU_PLACE_ID: The place_id from Baidu Maps, widely used in China. AMAP_PLACE_ID: The unique place_id in Amap, a mapping service popular in China. This field may be null if the identifier is unavailable in the supplier's system.
string | null
The name of the location as listed on the external platform. This provides a human-readable reference for the location and serves as an additional identifier for cross-platform consistency. This field may be null if the name is not available from the platform.
contact.externalPlatformLocations[].url
string (uri) | null
The URL of the supplier’s listing on the external platform. For example: A Google Maps link for a specific place (https://maps.google.com/?q=place_id:<id>). A Tripadvisor URL for the location's profile page. A Yelp link to the business’s review page. This field may be null if no URL is provided by the platform or if it is unavailable.
logoImages[]
array<object> | null (logoImages object)
An array containing the supplier's logo images. Multiple variations of the logo can be provided to support different use cases. The objects must be ordered according to the supplier's preference, ensuring that the most relevant version is presented first. This field can be null if no logo images are available.
logoImages[].url
string (uri) | null
The URL of the logo image file, which should be a direct link to the image hosted on a server. Recommended formats include PNG or SVG for scalability and quality. This field should not point to dynamic or temporary links and may be null if no logo image is available.
logoImages[].copyright
string | null
Information about the copyright status of the logo image or any applicable usage restrictions. This field may include details about ownership, licensing terms, or attribution requirements. If null, it assumes there are no copyright restrictions or attribution requirements associated with the image.
socialMedia[]
array<object> | null (socialMedia object)
An optional list of social media profiles associated with the supplier. Each object represents a single social media profile on a specific platform. These profiles are used to enhance the supplier's online presence and provide customers with additional ways to engage. This field can be null if no social media profiles are linked.
socialMedia[].platform
string (enum: FACEBOOK, X, INSTAGRAM, LINKEDIN, YOUTUBE, TIKTOK, DOUYIN, WECHAT, PINTEREST, OTHER)
The platform associated with the social media profile. Ideally, the value should be one of the predefined options, which include: FACEBOOK: The profile page on Facebook. X: The profile on X.com (formerly Twitter). INSTAGRAM: The supplier's profile on Instagram. LINKEDIN: The business's page or profile on LinkedIn. YOUTUBE: The supplier's YouTube channel or video profile. TIKTOK: The supplier's presence on TikTok. DOUYIN: The Chinese version of TikTok (Douyin). WECHAT: The supplier's profile or page on WeChat, widely used in China. PINTEREST: The supplier's presence on Pinterest for showcasing visual content. OTHER: A generic option for platforms not explicitly listed. This field ensures accurate representation of the supplier's social media presence.
socialMedia[].url
string (uri) | null
The URL of the supplier's social media profile. This link should direct users to the profile on the specified platform, enhancing accessibility and engagement. Below are examples for each platform: FACEBOOK: The URL to the business's Facebook page (e.g., https://www.facebook.com/{page_name}). X: The link to the user's profile on X.com (formerly Twitter), formatted as https://x.com/{username}. INSTAGRAM: The URL to the supplier's Instagram profile (e.g., https://www.instagram.com/{username}). LINKEDIN: The URL to the supplier's LinkedIn page (e.g., https://www.linkedin.com/company/{company_name}). YOUTUBE: The URL to the YouTube channel (e.g., https://www.youtube.com/c/{channel_name}). TIKTOK: The link to the supplier's TikTok profile (e.g., https://www.tiktok.com/@{username}). DOUYIN: The profile link on Douyin, if available, would be in a similar format as TikTok. WECHAT: WeChat profile URLs may not always be accessible publicly. If available, use a valid link. PINTEREST: The link to the Pinterest board or profile (e.g., https://www.pinterest.com/{username}). If the profile does not have a URL or is inaccessible, this field can be null.
socialMedia[].username
string | null
The username or handle associated with the supplier's social media profile on the specific platform. This helps identify the profile uniquely and may be used for searches or direct interactions on the platform. Below are platform-specific details for usernames: FACEBOOK: The page name or custom URL handle (e.g., {page_name}). X: The username or handle used on X.com (e.g., @username). INSTAGRAM: The username associated with the profile (e.g., @username). LINKEDIN: The LinkedIn handle, typically the company name (e.g., {company_name}). YOUTUBE: The channel name or user handle (e.g., {channel_name}). TIKTOK: The username used to identify the profile (e.g., @username). DOUYIN: The username used on Douyin, which is similar to TikTok. WECHAT: The WeChat ID or handle for the profile, if available. PINTEREST: The username associated with the Pinterest account (e.g., {username}). If the username is unavailable, this field can be null.
socialMedia[].profileId
string | null
The unique identifier or profile ID of the social media account. This could be a user ID or any unique string assigned by the platform to identify the profile. Below are details for each platform: FACEBOOK: The numeric ID of the page, which is used for API calls or direct identification (e.g., 1234567890). X: The user ID assigned by X.com (formerly Twitter) to uniquely identify the user, which is different from the username. INSTAGRAM: The user ID assigned by Instagram, which may differ from the public username. LINKEDIN: The company or profile ID assigned by LinkedIn, typically used for API integration. YOUTUBE: The channel ID, which uniquely identifies the YouTube channel. TIKTOK: The unique user ID assigned by TikTok to the profile. DOUYIN: The unique user ID on Douyin, similar to TikTok. WECHAT: The unique identifier for a WeChat account, which may include an official account ID. PINTEREST: The unique user ID assigned by Pinterest. This field can be null if the platform does not provide a unique identifier.
additionalContacts[]
array<object> | null (additionalContact object)
An array containing additional points of contact for partners, such as travel trade agents, connectivity partners, or customer support representatives. These contacts are intended for internal or business partner use and must not be displayed to end customers. This field provides structured details about key individuals or teams responsible for various operational or business areas. It can be null if no additional contacts are specified in the system.
additionalContacts[].fullName
string | null
The full name of the contact person, team, or department. This name should be formatted professionally, including first and last names (e.g., "John Doe") or the official title of the team or department (e.g., "Global Support Team"). This field may be null if no name is available.
additionalContacts[].role
string | null
The role or position of the contact within the supplier's organization. This field specifies the area of responsibility or expertise, such as "Head of Global Travel Trade," "Customer Support Manager," or "Connectivity Specialist." Providing a clear and professional role description helps partners understand the contact’s purpose. This field can be null if no role information is provided.
additionalContacts[].type
array<string> (enum: TRAVEL_TRADE, CONNECTIVITY, CUSTOMER_SUPPORT, OPERATIONS, CONTENT_QUALITY, FINANCE, OTHER)
This field specifies the topics or primary areas of responsibility that the contact person or team can address. Possible values include: TRAVEL_TRADE: Contacts who manage topics related to travel agents, tour operators, or other travel trade partnerships. CONNECTIVITY: Technical or operational contacts who handle topics such as API integrations, platform connectivity, or system integration issues. CUSTOMER_SUPPORT: Contacts who address customer-related topics, including complaints, queries, or troubleshooting. OPERATIONS: Contacts responsible for logistical or operational topics such as on-the-ground coordination, inventory, or day-to-day management. CONTENT_QUALITY: Contacts responsible for ensuring the accuracy, relevance, and quality of content, such as descriptions, images, or videos provided for the supplier's offerings. FINANCE: Contacts who manage financial topics, including payments, invoices, or revenue reconciliation. OTHER: A generic category for topics that do not fit the predefined options. This field ensures clarity about the contact’s expertise and the appropriate topics for communication.
additionalContacts[].telephone
string | null (E.164)
The telephone number of the contact person, team, or department, formatted in the E.164 international standard. This format includes the country code followed by the national number, with no spaces, dashes, or special characters (e.g., "+441202666903"). This number should be reachable for inquiries related to their area of expertise. The field may be null if no telephone contact is available.
additionalContacts[].email
string (email) | null
The email address of the contact person, team, or department. This email should be a valid and monitored address intended for inquiries about topics related to their area of responsibility. This field is critical for establishing efficient communication but may be null if no email address is provided.
venues[]
array<object> | null (venue object)
An array containing information about the supplier's sub-divisions, destinations, brands, or specific locations (referred to as venues). This field allows for additional structure when needed to represent more specific or localized details about the supplier. If defined, venue information should be ingested by resellers as a more specific representation of the supplier. This field can be null if no venues are applicable.
venues[].id
string
A unique identifier for the venue, used across the platform to represent this specific sub-division or location. This identifier must be unique within the supplier's system.
venues[].name
string
The name of the venue. This name should clearly represent the venue’s identity or brand, ensuring consistency across platforms and visibility to resellers. If null, resellers should use the supplier.name field as a fallback.
venues[].legalName
string | null
The official registered name of the venue's company or organization, as recognized by legal or governmental authorities. This field is used in formal or legal contexts, such as contracts or regulatory filings. If null, resellers should use the supplier.legalName field.
venues[].shortDescription
string | null
A customer-facing brief summary or description of the venue, designed to provide a concise overview of the business and its unique characteristics. This field gives customers a quick understanding of the venue’s purpose, services, or notable offerings. The recommended length is 150–300 characters to ensure clarity and brevity. If null, resellers should default to the supplier.shortDescription field.
venues[].contact
object (supplierContact object)
An object containing structured contact details for the venue, including website, email, telephone, and address information. If null, resellers should use the supplier.contact object as a fallback for these fields.
venues[].contact.website
string (uri) | null
The official website URL for the venue. This can link directly to a page about the venue or its specific services. If null, resellers should use supplier.contact.website.
venues[].contact.email
string (email) | null
The email address for customer service inquiries for the venue. This email should be monitored for resolving queries specific to the venue. If null, resellers should use supplier.contact.email.
venues[].contact.telephone
string | null (E.164)
The telephone number for customer service inquiries specific to the venue, formatted in the E.164 international standard. If null, resellers should use supplier.contact.telephone.
venues[].contact.address
string | null
The full mailing address of the location as a single string. It includes street address, city, state, postal code, and country. If no address is provided, this field can be null. For structured details, use the additional address-related fields
venues[].contact.addressLine1
string | null
The primary address line, typically used for the street address, P.O. box, or company name. This field is equivalent to address but structured separately for where this level of detail is needed. It can be null if no address information is provided.
venues[].contact.addressLine2
string | null
The secondary address line for additional details, such as apartment numbers, suites, units, or building names. This field is equivalent to part of contact.address in OCTO Core but structured separately for where this level of detail is needed. It can be null if not applicable.
venues[].contact.city
string | null
The name of the city or locality associated with the address. This value can be null if the city is not available or not required.
venues[].contact.stateProvinceRegion
string | null
The state, province, or region associated with the address. This field is equivalent to part of address but structured separately for cases where this information is critical. It can be null if such administrative divisions are not applicable.
venues[].contact.postalCode
string | null
The postal code or ZIP code for the address. This field is equivalent to part of address but structured separately for postal-specific details.
venues[].contact.country
string | null (ISO 3166-1 alpha-2)
The two-letter country code for the address, formatted in ISO 3166-1 alpha-2 (e.g., "US" for the United States). This field is equivalent to part of address but structured separately for identifying the country. It can be null if not provided.
venues[].contact.latitude
float | null (decimal degrees)
The latitude of the location, expressed in decimal degrees. This geospatial coordinate is structured separately for more precise geographic pinpointing.
venues[].contact.longitude
float | null (decimal degrees)
The longitude of the location, expressed in decimal degrees. Similar to latitude, this field provides geospatial data that complements address.
venues[].contact.externalPlatformLocations[]
array<object> | null (externalPlatformLocation object)
A list of unique identifiers for the location from external platforms, such as Google Maps, Apple Maps, Tripadvisor, or other mapping and location services. This field is an optional extension to address field providing external references for mapping, third-party integrations, or enhanced location visibility. These references help integrate the supplier’s location with third-party systems for seamless navigation or cross-platform mapping. It may be null if no identifiers exist in the supplier's system.
venues[].contact.externalPlatformLocations[].type
string (enum: GOOGLE_PLACE_ID, APPLE_PLACE_ID, TRIPADVISOR_LOCATION_ID, YELP_PLACE_ID, FACEBOOK_PLACE_ID, FOURSQUARE_PLACE_ID, BAIDU_PLACE_ID, AMAP_PLACE_ID, OTHER)
The type of external platform providing the location identifier. Possible values include: GOOGLE_PLACE_ID: A unique identifier for a location on Google Maps, retrievable via the Google Maps API. APPLE_PLACE_ID: A unique identifier for a location in Apple Maps, retrievable via Apple’s Maps API. TRIPADVISOR_LOCATION_ID: An identifier for a location on Tripadvisor, used to link reviews, ratings, or other data from the Tripadvisor Content API. YELP_PLACE_ID: A unique identifier for a business or location on Yelp, often tied to user reviews and ratings. FACEBOOK_PLACE_ID: An identifier for a location on Facebook, linking to the business’s page or check-in location. FOURSQUARE_PLACE_ID: A unique identifier for a venue or location in Foursquare’s database. BAIDU_PLACE_ID: An identifier for a location in Baidu Maps, primarily used in China. AMAP_PLACE_ID: A unique identifier for a location in Amap (Gaode Maps), another popular mapping service in China. OTHER: A generic option for identifiers from platforms not explicitly listed.
venues[].contact.externalPlatformLocations[].id
string | null
The unique identifier assigned to the supplier’s location by the specified platform. Each type corresponds to a specific kind of ID: GOOGLE_PLACE_ID: The unique place_id from Google Maps, retrievable through the Google Places API. APPLE_PLACE_ID: The place.id provided by Apple Maps API for a location. TRIPADVISOR_LOCATION_ID: The location_id from the Tripadvisor Content API, linking to reviews and other Tripadvisor data. YELP_PLACE_ID: The unique ID for a business location on Yelp. FACEBOOK_PLACE_ID: The page or place ID used by Facebook for location check-ins or business pages. FOURSQUARE_PLACE_ID: The venue ID from Foursquare’s API, providing location-specific data. BAIDU_PLACE_ID: The place_id from Baidu Maps, widely used in China. AMAP_PLACE_ID: The unique place_id in Amap, a mapping service popular in China. This field may be null if the identifier is unavailable in the supplier's system.
venues[].contact.externalPlatformLocations[].name
string | null
The name of the location as listed on the external platform. This provides a human-readable reference for the location and serves as an additional identifier for cross-platform consistency. This field may be null if the name is not available from the platform.
venues[].contact.externalPlatformLocations[].url
string (uri) | null
The URL of the venues listing on the external platform. For example: A Google Maps link for a specific place (https://maps.google.com/?q=place_id:<id>). A Tripadvisor URL for the location's profile page. A Yelp link to the business’s review page. This field may be null if no URL is provided by the platform or if it is unavailable.
venues[].logoImages[]
array<object> | null (logoImages object)
An array containing the supplier's logo images. Multiple variations of the logo can be provided to support different use cases. The objects must be ordered according to the supplier's preference, ensuring that the most relevant version is presented first. This field can be null if no logo images are available.
venues[].logoImages[].url
string (uri) | null
The URL of the logo image file, which should be a direct link to the image hosted on a server. Recommended formats include PNG or SVG for scalability and quality. This field should not point to dynamic or temporary links and may be null if no logo image is available.
venues[].logoImages[].copyright
string | null
Information about the copyright status of the logo image or any applicable usage restrictions. This field may include details about ownership, licensing terms, or attribution requirements. If null, it assumes there are no copyright restrictions or attribution requirements associated with the image.
venues[].socialMedia[]
array<object> | null (socialMedia object)
An optional list of social media profiles associated with the supplier. Each object represents a single social media profile on a specific platform. These profiles are used to enhance the supplier's online presence and provide customers with additional ways to engage. This field can be null if no social media profiles are linked.
venues[].socialMedia[].platform
string (enum: FACEBOOK, X, INSTAGRAM, LINKEDIN, YOUTUBE, TIKTOK, DOUYIN, WECHAT, PINTEREST, OTHER)
The platform associated with the social media profile. Ideally, the value should be one of the predefined options, which include: FACEBOOK: The profile page on Facebook. X: The profile on X.com (formerly Twitter). INSTAGRAM: The supplier's profile on Instagram. LINKEDIN: The business's page or profile on LinkedIn. YOUTUBE: The supplier's YouTube channel or video profile. TIKTOK: The supplier's presence on TikTok. DOUYIN: The Chinese version of TikTok (Douyin). WECHAT: The supplier's profile or page on WeChat, widely used in China. PINTEREST: The supplier's presence on Pinterest for showcasing visual content. OTHER: A generic option for platforms not explicitly listed. This field ensures accurate representation of the supplier's social media presence.
venues[].socialMedia[].url
string (uri) | null
The URL of the venue's social media profile. This link should direct users to the profile on the specified platform, enhancing accessibility and engagement. Below are examples for each platform: FACEBOOK: The URL to the business's Facebook page (e.g., https://www.facebook.com/{page_name}). X: The link to the user's profile on X.com (formerly Twitter), formatted as https://x.com/{username}. INSTAGRAM: The URL to the supplier's Instagram profile (e.g., https://www.instagram.com/{username}). LINKEDIN: The URL to the supplier's LinkedIn page (e.g., https://www.linkedin.com/company/{company_name}). YOUTUBE: The URL to the YouTube channel (e.g., https://www.youtube.com/c/{channel_name}). TIKTOK: The link to the supplier's TikTok profile (e.g., https://www.tiktok.com/@{username}). DOUYIN: The profile link on Douyin, if available, would be in a similar format as TikTok. WECHAT: WeChat profile URLs may not always be accessible publicly. If available, use a valid link. PINTEREST: The link to the Pinterest board or profile (e.g., https://www.pinterest.com/{username}). If the profile does not have a URL or is inaccessible, this field can be null.
venues[].socialMedia[].username
string | null
The username or handle associated with the venue's social media profile on the specific platform. This helps identify the profile uniquely and may be used for searches or direct interactions on the platform. Below are platform-specific details for usernames: FACEBOOK: The page name or custom URL handle (e.g., {page_name}). X: The username or handle used on X.com (e.g., @username). INSTAGRAM: The username associated with the profile (e.g., @username). LINKEDIN: The LinkedIn handle, typically the company name (e.g., {company_name}). YOUTUBE: The channel name or user handle (e.g., {channel_name}). TIKTOK: The username used to identify the profile (e.g., @username). DOUYIN: The username used on Douyin, which is similar to TikTok. WECHAT: The WeChat ID or handle for the profile, if available. PINTEREST: The username associated with the Pinterest account (e.g., {username}). If the username is unavailable, this field can be null.
venues[].socialMedia[].profileId
string | null
The unique identifier or profile ID of the social media account. This could be a user ID or any unique string assigned by the platform to identify the profile. Below are details for each platform: FACEBOOK: The numeric ID of the page, which is used for API calls or direct identification (e.g., 1234567890). X: The user ID assigned by X.com (formerly Twitter) to uniquely identify the user, which is different from the username. INSTAGRAM: The user ID assigned by Instagram, which may differ from the public username. LINKEDIN: The company or profile ID assigned by LinkedIn, typically used for API integration. YOUTUBE: The channel ID, which uniquely identifies the YouTube channel. TIKTOK: The unique user ID assigned by TikTok to the profile. DOUYIN: The unique user ID on Douyin, similar to TikTok. WECHAT: The unique identifier for a WeChat account, which may include an official account ID. PINTEREST: The unique user ID assigned by Pinterest. This field can be null if the platform does not provide a unique identifier.
venues[].additionalContacts[]
array<object> | null (additionalContact object)
An array containing additional points of contact for partners, such as travel trade agents, connectivity partners, or customer support representatives. These contacts are intended for internal or business partner use and must not be displayed to end customers. This field provides structured details about key individuals or teams responsible for various operational or business areas. It can be null if no additional contacts are specified in the system.
venues[].additionalContacts[].fullName
string | null
The full name of the contact person, team, or department. This name should be formatted professionally, including first and last names (e.g., "John Doe") or the official title of the team or department (e.g., "Global Support Team"). This field may be null if no name is available.
venues[].additionalContacts[].role
string | null
The role or position of the contact within the venue or supplier organization. This field specifies the area of responsibility or expertise, such as "Head of Global Travel Trade," "Customer Support Manager," or "Connectivity Specialist." Providing a clear and professional role description helps partners understand the contact’s purpose. This field can be null if no role information is provided.
venues[].additionalContacts[].type
array<string> (enum: TRAVEL_TRADE, CONNECTIVITY, CUSTOMER_SUPPORT, OPERATIONS, OTHER)
This field specifies the topics or primary areas of responsibility that the contact person or team can address. Possible values include: TRAVEL_TRADE: Contacts who manage topics related to travel agents, tour operators, or other travel trade partnerships. CONNECTIVITY: Technical or operational contacts who handle topics such as API integrations, platform connectivity, or system integration issues. CUSTOMER_SUPPORT: Contacts who address customer-related topics, including complaints, queries, or troubleshooting. OPERATIONS: Contacts responsible for logistical or operational topics such as on-the-ground coordination, inventory, or day-to-day management. CONTENT_QUALITY: Contacts responsible for ensuring the accuracy, relevance, and quality of content, such as descriptions, images, or videos provided for the supplier's offerings. FINANCE: Contacts who manage financial topics, including payments, invoices, or revenue reconciliation. OTHER: A generic category for topics that do not fit the predefined options. This field ensures clarity about the contact’s expertise and the appropriate topics for communication.
venues[].additionalContacts[].telephone
string | null (E.164)
The telephone number of the contact person, team, or department, formatted in the E.164 international standard. This format includes the country code followed by the national number, with no spaces, dashes, or special characters (e.g., "+441202666903"). This number should be reachable for inquiries related to their area of expertise. The field may be null if no telephone contact is available.
venues[].additionalContacts[].email
string (email) | null
The email address of the contact person, team, or department. This email should be a valid and monitored address intended for inquiries about topics related to their area of responsibility. This field is critical for establishing efficient communication but may be null if no email address is provided.
Last updated