Skip to content
Schemas
/
ProductTypeOptions

BeMyGuest API v2.0 (2.1)

The BeMyGuest API is the industry benchmark preferred by online travel agents, designed solely for Asia's attractions, tours and activities. This comprehensive API provides real-time access to a vast inventory of travel products.

Key Features:

  • Product Discovery: Search and retrieve detailed information for a wide range of travel products, including attractions, tours, and activities.
  • Real-Time Availability and Pricing: Check live availability and get up-to-date pricing for specific product types and dates.
  • End-to-End Booking Management: Create, confirm, and cancel bookings seamlessly.
  • Voucher Retrieval: Access and download booking vouchers directly through the API.
  • Configuration: Fetch essential configuration data such as supported languages, currencies, and locations to customize your integration.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.bemyguest.com.sg/contact-us

BeMyGuest API Support

support@bemyguest.com.sg

Languages
Servers
Mock server

https://docs.bemyguest.com.sg/_mock/openapi/

Api Demo Server

https://api.demo.bemyguest.com.sg/

Api Production Server

https://api.bemyguest.com.sg/

Products

Endpoints for searching and retrieving product details.

Operations

Product-Types

Endpoints for retrieving product type information, pricing, and availability.

Operations

Bookings

Endpoints for creating and managing bookings.

Operations

Configuration

Endpoints for retrieving API configuration data.

Operations

Requests

Schemas that define requests.

Responses

Schemas that define API responses.

webhooks

Webhooks

ProductTypeOption

A booking option that is a available for a ProductType

uuidstringrequired
namestringrequired
nameTranslatedstringrequired
descriptionstringrequired
descriptionTranslatedstringrequired
requiredbooleanrequired
addOnbooleanrequired
formatRegexstringrequired
inputTypeintegerint32required
minNumberintegerint32required
maxNumberintegerint32required
validFromstringrequired
validTostringrequired
{
  "uuid": "string",
  "name": "string",
  "nameTranslated": "string",
  "description": "string",
  "descriptionTranslated": "string",
  "required": true,
  "addOn": false,
  "formatRegex": "string",
  "inputType": 4,
  "minNumber": 0,
  "maxNumber": 0,
  "validFrom": "string",
  "validTo": "string"
}

ProductTypeOptions

perBookingArray of objects(ProductTypeOption)>= 0 items

Options per booking array

perBooking[].​uuidstringrequired
perBooking[].​namestringrequired
perBooking[].​nameTranslatedstringrequired
perBooking[].​descriptionstringrequired
perBooking[].​descriptionTranslatedstringrequired
perBooking[].​requiredbooleanrequired
perBooking[].​addOnbooleanrequired
perBooking[].​formatRegexstringrequired
perBooking[].​inputTypeintegerint32required
perBooking[].​minNumberintegerint32required
perBooking[].​maxNumberintegerint32required
perBooking[].​validFromstringrequired
perBooking[].​validTostringrequired
perPaxArray of objects(ProductTypeOption)>= 0 items

Options that are required/available for each person on the booking

perPax[].​uuidstringrequired
perPax[].​namestringrequired
perPax[].​nameTranslatedstringrequired
perPax[].​descriptionstringrequired
perPax[].​descriptionTranslatedstringrequired
perPax[].​requiredbooleanrequired
perPax[].​addOnbooleanrequired
perPax[].​formatRegexstringrequired
perPax[].​inputTypeintegerint32required
perPax[].​minNumberintegerint32required
perPax[].​maxNumberintegerint32required
perPax[].​validFromstringrequired
perPax[].​validTostringrequired
{
  "perBooking": [
    { … }
  ],
  "perPax": [
    { … }
  ]
}

ProductTypeSummary

Short Summary of Product Type displayed when fetching a list of available product types

uuidstring
titlestring
linksArray of objects(Link)
links[].​methodstringrequired
links[].​relstringrequired
links[].​hrefstringrequired
{
  "uuid": "efedb1fc-f150-5eaa-bf6e-fc202f6114bd",
  "title": "Universal Studios Singapore E-ticket",
  "links": [
    { … }
  ]
}