Suppliers
A Supplier (sometimes referred to as an operator) represents a provider of tours or attractions. A Booking System may contain one or multiple Suppliers. Each Supplier must be unique within the Booking System.
Clients of the Booking System may call the /suppliers endpoint to retrieve a list of all the Suppliers they have access to.
Reference can be found here
Supplier
| Field Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | This MUST be unique within the scope of the Booking Platform (1024 character limit). |
name | string | Yes | Name of the supplier or operator providing the products or experiences. |
title | string | No | Customer-facing name of the supplier, intended for display in UIs. |
description | string | No | A detailed overview of the supplier or operator, highlighting their offerings, background, and value proposition. This content is intended for display in full detail pages and should help users understand what makes the supplier unique. |
endpoint | string | No | This is the base URL that will be prepended to ALL other paths. The value SHOULD NOT contain a trailing /. |
contact | object | No | Contact details for the supplier. |
website | string | No | This SHOULD be the website of the Supplier that is separate from the Booking Platform but MAY be a unique destination within the Booking Platform about the Supplier. |
email | string | No | This SHOULD be the email support contact for the Supplier. This information MAY be provided to the customer. |
telephone | string | No | This SHOULD be the phone support contact for the Supplier. This information MAY be provided to the customer. |
address | string | No | This SHOULD be the mail address support contact for the Supplier. This information MAY be provided to the customer. |
firstName | string | No | First name of the supplier contact. |
lastName | string | No | Last name of the supplier contact. |
The name, title, and description fields on the main entities - Supplier, Product, Option, and Unit - are treated as standard fields, not content fields.
Operators who do not implement content capability may continue using these fields.
External Booking Systems
The OBS Supplier object provides support for distributed or on-premises supplier reservation systems through the use of the endpoint parameter. For example, a centralized supplier "list server" can provide Redeam with a list of suppliers & the address of their supporting systems.
The endpoint parameter must be provided WITHOUT a trailing '/'. The presence of this parameter will instruct the OBS client to direct all Product, Availability, and Booking queries to the provided endpoint address.
Capabilities
The following capabilities are supported by the Supplier object (click the link to learn more!):