Scenarios

Discover all of our scenarios to consume your Club Med API

81 results found
Activity option6 routes

Add childcare services to a proposal

How do I add childcare services before the booking is created?

Services2 routes

Retrieve locale schema

How to retrieve the validation schema for a resource in a given locale or country?

Transport1 route

List transport stations

How do I list the transport stations available for a locale?

Booking4 routes

Modify room in a proposal

How can I change the room arrangement of an existing proposal?

Services3 routes

Add insurance to a booking

How do I list available insurances and add one to an existing booking?

Booking8 routes

Bookings: Booking journey

How do I turn a booking intent into a confirmed option?

Option creation4 routes

Proposals: Add or change accommodations

How do I add more rooms or change the accommodation split in a proposal?

Booking4 routes

Save and consult proposals for a customer

How do I search, save, and later consult proposals for a customer?

Services3 routes

Add external services to a proposal

How do I retrieve and display the external services available for a proposal?

Services1 route

Retrieve supported locales

How do I list the locales supported by the API?

Customer account2 routes

Retrieve and update customer information

How do I retrieve a customer profile and update their information?

Booking upsell5 routes

Book a spa

How to let a customer browse, book, and cancel a spa appointment from a booking?

Services1 route

Request Wi-Fi access

How do I transmit a Wi-Fi access request from the dedicated form?

Transport2 routes

Proposals: Transport selection journey

How do I change the transportation in my proposal?

Shopping calendar1 route

Price calendar

How do I retrieve the price calendar for a resort product?

Option creation3 routes

Proposals: advanced room allocation

How do I fine-tune room allocation in a proposal?

Customer account3 routes

Create and update a customer

How do I create a customer and then complete the profile?

Services4 routes

Add a service to a proposal

How do I add a service to an existing proposal?

Booking6 routes

Complete booking journey

How do I move from a proposal to a validated and reviewed booking?

Services3 routes

Save a proposal for CMTA validation

How do I create a proposal and make it available in CMTA?

GO1 route

Get the G.O list

How do I retrieve the G.O list of a resort?

Shopping calendar1 route

Shopping Calendar for a Specific Product

How to plan your stay using the product calendar?

Customer account3 routes

Subscribe a customer to a newsletter and manage the subscription

How do I create, review, and update a newsletter subscription?

Customer account5 routes

Manage travelers and travel documents for a customer

How can I manage travelers and travel documents for a customer account?

Booking upsell4 routes

Add services to an existing booking

How do I add services to an existing booking?

Resort content1 route

Retrieve Cruise Stopovers

How do I retrieve the stopovers of a cruise?

Shopping18 routes

Build a shopping experience with the Club Med API

How do I list products, accommodations, and prices with the Shopping API?

Prebooking2 routes

Browse products and inspect a product detail

How do I list available products and retrieve one product detail?

Shopping calendar2 routes

Flexible search (duration and dates)

How do I explore bookable dates and durations before selecting a departure?

Payment1 route

Retrieving payment schedule associated with a proposal

How can I view upcoming payments?

Resort content1 route

Enrich a product page with Tripadvisor reviews

How do I retrieve Tripadvisor ratings, awards, and reviews for a product?

Shopping2 routes

Browse Club Med offers

How can I retrieve the list of Club Med offers and inspect one in detail?

Resort content1 route

Retrieve a resort area map

How can I retrieve the area map data for a resort?

Option creation6 routes

Retrieve More Accommodations

How do I add more accommodations to an existing proposal?

Transfer option4 routes

Add a transfer to a proposal

How do I add a transfer service to an existing proposal?

Booking2 routes

Save and consult customer search criteria

How can I save and later retrieve search criteria in a customer account?

Prebooking3 routes

Arrival form

How can a customer review and complete the arrival formalities for a booking?

Booking1 route

Retrieve seller bookings

How can a seller retrieve the list of bookings they manage?

Payment2 routes

Retrieve payment methods and providers

How do I list payment providers and the methods they expose?

Prebooking2 routes

Browse and inspect Club Med products

How do I list Club Med products and inspect one product in detail?

Resort content1 route

Retrieve resort accommodations

How do I browse a resort accommodation catalogue?

Resort content1 route

Retrieve accommodations for a product

How do I retrieve the accommodations available for a Club Med product?

Prebooking2 routes

Prebooking Path

How do I turn a proposal search into a prebooking step?

Resort content1 route

List Club Med destinations

How do I list Club Med destinations by geographic area?

Booking docs2 routes

Retrieve booking sales contract

How do I list and download the sales contracts attached to a booking?

Shopping1 route

Best product prices

How do I search informative prices for one or more products?

Booking3 routes

Save and reopen a seller proposal

How can a seller save a proposal and reopen it later?

Customer account3 routes

Modify a travel document

How do I modify a customer's travel document?

Booking1 route

Retrieve proposal commission

How can I retrieve the seller commission linked to a proposal?

Payment1 route

Retrieve a customer's eligible promotions

How do I retrieve a client's list of offers?

Booking5 routes

Cruises: select a cabin in a proposal

How do I build a cruise proposal and choose a physical cabin?

Payment1 route

View remaining balance for a proposal

How do I retrieve the payment schedule of a proposal and view the remaining balance?

Booking4 routes

Save a proposal to a customer account

How do I save a proposal and retrieve it from the customer account?

Booking2 routes

List and inspect a customer's bookings

How do I list a customer's bookings and open one in detail?

Booking docs2 routes

Travel documents

How do I consult and update a customer's travel documents?

Transport4 routes

Search with transport

How do I search proposals and apply another transport option?

Shopping calendar1 route

Shopping Calendar

How do I retrieve the product information needed to power a shopping calendar?

Payment1 route

View remaining balance for a booking

How do I retrieve the payment schedule of one booking?

Option creation1 route

Generate a PDF summary of a proposal

How do I generate a PDF document summarizing a travel proposal?

Services10 routes

Compare and apply counter-proposals

How do I identify, compare, and apply a Club Med counter-proposal?

Customer account1 route

Retrieve customer profile information

How do I access the detailed profile of an authenticated customer?

Resort content2 routes

Retrieve resort opening periods

How do I retrieve the opening dates and period information of a resort?

Services1 route

Get available locales

How to retrieve the list of configured locales?

Booking2 routes

Add attendees to your proposal

How do you add attendees to your proposal?

Resort content1 route

Retrieve resort dress codes for a given period

How can I retrieve a resort dress code for a specific period?

Resort content1 route

Retrieve a resort's yearly weather averages

How can I retrieve a resort's monthly weather averages over a full year?

Booking4 routes

Booking path with services and attendees

How do I prepare a proposal with services before turning it into a booking?

Resort content1 route

Retrieve a product's main themes

How can I retrieve the main themes highlighted for a product?

Resort content2 routes

Retrieve resort media

How can I retrieve the pictures and videos of a resort product?

Resort content2 routes

Retrieve resort period information

How do I retrieve the operating, event, and closure periods of a resort?

Resort content1 route

Retrieve resort dress code

How can I retrieve dress code events from resort planning?

Booking4 routes

Simple booking

How do I create a simple booking from a proposal?

Booking4 routes

Create a family booking with children

How do I create a family booking that includes children?

Customer account2 routes

Identify a customer from personal information

How do I identify a customer from personal filters and open the detailed profile?

Option creation1 route

Refresh a proposal

How can I recalculate a proposal with up-to-date stock and pricing?

Booking2 routes

Ducroire: finalize a booking with payment

How do I create a booking and validate it with one or more payments?

Prebooking1 route

Prepare a price estimate before ODR

How do I build a price estimate page before ODR from the product catalog?

Booking4 routes

Refresh a proposal and search accommodation arrangements

How do I inspect a proposal, refresh it, and compare accommodation arrangements?

Resort content4 routes

Retrieve resort highlights and must-try experiences

How do I retrieve a resort's strengths and must-try experiences?

Services6 routes

Book a spa treatment on an existing stay

How do I book and verify a spa appointment for a customer who already has a booking?

Booking4 routes

Booking path with option durations

How do I build a booking flow while monitoring a proposal's option duration?