Migration notes

Welcome to our guide on migrating notes for a REST API

Introduction

This page is dedicated to helping developers understand the process of transferring, updating, and managing notes within a REST architecture.

Whether you're looking to upgrade your existing API, change backend systems, or simply reorganize your data structure, this guide provides comprehensive instructions and best practices to ensure a smooth and efficient migration. Our aim is to equip you with the knowledge and tools necessary to handle this crucial aspect of API maintenance seamlessly.

About breaking changes

The Club Med REST API is versioned. The version is reflected on each routes from /v0 to vN.

For example, our main Product information route exists in /v0/products and /v1/products but our swagger documentation display only the latest version of the API (by default).

We don't create a global version for all routes, each route has its own version.

Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:

  • removing an entire operation
  • removing or renaming a parameter
  • removing or renaming a response field
  • adding a new required parameter
  • making a previously optional parameter required
  • changing the type of a parameter or response field
  • removing enum values
  • adding a new validation rule to an existing parameter
  • changing authentication or authorization requirements

Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:

  • adding an operation
  • adding an optional parameter
  • adding an optional request header
  • adding a response field
  • adding a response header
  • adding enum values

When a new REST API version is released, the previous API version will be supported for at least 6 more months following the release of the new version a route.

Breaking changes

Here are the routes that will be removed in the future. Please make sure to update your code accordingly.

WARNING

We have two states for breaking changes: deprecated and outdated.

  • The deprecated state means that the route will be removed in the future (6 months). Only critical bug fixes will be applied to the route.
  • The removed state means that the route is consumed by one our consumers. So the route are not removed yet but will be removed when it's possible. In this case the route is not maintained anymore.

Deprecated routes

The following migration notes cover routes which are marked as deprecated and will be removed from the ClubMed API in approximately 6 months. Please migrate to the recommended alternatives as soon as possible.

No deprecated route found

Outdated routes

The following routes were previously deprecated and have now reached their end of support. They have been removed or will be removed soon from the ClubMed API. Please ensure you have migrated to the recommended alternatives.

  • Impact Migration of the route GET ​/v1/products​/{product_id}​/pictures
    See more
    December 21, 2023
  • Migration of the endpoint PUT /v2/proposals/{proposal_id}/attendees to PUT /v3/proposals/{proposal_id}/attendees
    See more
    October 22, 2025
  • Migration of the route GET /v1/products/{product_id}/thematics to GET /v2/products/{product_id}/thematics
    See more
    August 4, 2025
  • Upgrade from GET /v1/products/{product_id}/facilities to GET /v2/products/{product_id}/facilities
    See more
    January 27, 2024
  • Migration of the route POST /v3/proposals/{proposal_id}/transport_details to POST /v4/proposals/{proposal_id}/transport_details
    See more
    June 1, 2025
  • Upgrade from GET /v0/transport_stations to GET /v1/transport_stations
    See more
    May 22, 2024
  • Impact migration of the route GET /v1/schemas/{resource}/{localeOrCountry} to GET /v2/schemas/{resource}/{localeOrCountry}
    See more
    October 30, 2024
  • Impact migration of the route POST /v2/proposals/{proposal_id}/transport_details to POST /v3/proposals/{proposal_id}/transport_details
    See more
    October 20, 2024
  • Impacts migration de la route POST /v1/proposals/{proposal_id}/accommodations_arrangement/search
    See more
    May 1, 2022
  • Impact depreciation of the route GET /v0/cities/{city_id}
    See more
    February 5, 2023
  • Impact Migration of POST/v2/proposals/{proposal_id}/alternative_transports to POST /v0/proposals/{proposal_id}/available_transports
    See more
    May 1, 2025
  • Depreciation of the route GET /v1/products/{product_id}/bars
    See more
    January 1, 2024
  • Upgrade from GET /v0/proposals/{proposal_id}/accommodations_arrangement to GET /v1/proposals/{proposal_id}/accommodations_arrangement
    See more
    April 30, 2024
  • Migration of the route GET /v0/products/{product_id}/bookable_dates to GET /v1/products/{product_id}/bookable_dates
    See more
    June 10, 2025
  • Migration of the route GET /v2/schemas/{resource}/{localeOrCountry} to GET /v3/schemas/{resource}/{localeOrCountry}
    See more
    May 30, 2025
  • Migration of the endpoint POST /v4/proposals/{proposal_id}/transport_details to POST /v5/proposals/{proposal_id}/transport_details
    See more
    November 15, 2025
  • Impact Migration of POST/v0/accommodations_arrangement/search to POST /v1/accommodations_arrangement/search
    See more
    March 9, 2025
  • Impacts migration de la route GET /v1/customers/{customer_id}/bookings
    See more
    September 1, 2021
  • Upgrade from PUT ​/v0​/proposals​/{proposal_id}​/accommodations_arrangement to PUT ​/v1​/proposals​/{proposal_id}​/accommodations_arrangement
    See more
    June 1, 2024
  • Impact Migration of the endpoint v0/offers to v1/offers
    See more
    January 2, 2025
  • Migration of the route GET /v1/products/{product_id} to GET /v2/products/{product_id}
    See more
    June 1, 2025
  • Upgrade from PUT /v1/proposals/{proposal_id}/attendees to PUT /v2/proposals/{proposal_id}/attendees
    See more
    June 1, 2024
  • Impact migration of the route GET /v1/proposals/{proposal_id}/transport_details
    See more
    September 16, 2023
  • Upgrade from GET /v1/bookings to GET /v2/bookings
    See more
    May 3, 2024
  • Migration of the route GET /v1/products/{product_id}/calendar to GET /v2/products/{product_id}/calendar
    See more
    June 10, 2025
  • Migration of the route GET /v3/customers/{customer_id}/bookings/{booking_id}/transport_details to GET /v4/customers/{customer_id}/bookings/{booking_id}/transport_details
    See more
    June 1, 2025
  • Migration of the endpoint GET /v4/proposals/{proposal_id}/transport_details to GET /v5/proposals/{proposal_id}/transport_details
    See more
    November 15, 2025
  • Impacts migration of the route GET /v0/customers/{customer_id}/commercial_offers
    See more
    November 10, 2023
  • Impacts migration de la route GET /v1/products​/{product_id}​/accommodations​/{accommodation_id}
    See more
    July 5, 2022
  • Migration of the route GET /v1/products/ to GET /v2/products/
    See more
    June 1, 2025
  • Impact migration of the route GET /v0/offers/{offer_id}
    See more
    June 5, 2023
  • Impact migration of the route POST /v2​/bookings
    See more
    October 11, 2023
  • Impact migration of the route PATCH /v0/customers/{customer_id}/profile
    See more
    October 11, 2023
  • Impacts migration de la route GET /v1/products/{product_id}/activities
    See more
    August 15, 2022
  • Migration of the endpoint POST /v0/subscriptions to POST /v1/subscriptions
    See more
    September 1, 2025
  • Impacts migration de la route GET /v1/products/{product_id}/accommodations
    See more
    July 5, 2022
  • Impact migration of the route GET /v2/proposals/{proposal_id}/transport_details to GET /v3/proposals/{proposal_id}/transport_details
    See more
    October 20, 2024
  • Depreciation of the route GET /v1/products/{product_id}/restaurants
    See more
    January 1, 2024
  • Impact Migration of the route POST /v1/proposals/{proposal_id}/alternative_transports
    See more
    January 8, 2025
  • Impact migration of the route POST /v1/proposals/{proposal_id}/transport_details
    See more
    September 16, 2023
  • Migration of the route GET /v2/bookings/{booking_id}/transport_details to GET /v3/bookings/{booking_id}/transport_details
    See more
    June 1, 2025
  • Migration of the route POST /v0/proposals/{proposal_id}/available_transports to POST /v1/proposals/{proposal_id}/available_transports
    See more
    June 1, 2025
  • Impact migration of the route GET /v0/products/{product_id}/thematics
    See more
    June 15, 2024
  • Impact migration of the route GET /v1/customers/{customer_id}/profile
    See more
    December 24, 2024
  • Migration of the route GET /v1/customers/{customer_id}/bookings/{booking_id}/services
    See more
    May 16, 2024
  • Impact migration of the route GET /v0/customers
    See more
    June 1, 2023
  • Impacts migration of the route GET /v0/customers/{customer_id}/travel_documents
    See more
    January 20, 2023
  • Impact migration of the route DELETE /v0/customers/{customer_id}/proposals/{proposal_id} to DELETE /v0/proposals/{proposal_id}
    See more
    September 30, 2024
  • Migration of the endpoint POST /v0/wifi_access_request to POST /v1/wifi_access_request
    See more
    August 1, 2025
  • Migration of the endpoint PATCH /v0/subscriptions/{subscription_id} to PATCH /v1/subscriptions/{subscription_id}
    See more
    September 1, 2025
  • Migration of the endpoint POST /v0/proposals/search/best to POST /v1/proposals/search/best
    See more
    December 5, 2025
  • Upgrade GET/v2/customers/{customer_id}/bookings/{booking_id}/transport_details to GET/v3/customers/{customer_id}/bookings/{booking_id}/transport_details
    See more
    June 25, 2024
  • Evolution of GET /v0/products/{product_id}/must_try_experiences in GET v0/products/{product_id}/highlights
    See more
    April 30, 2024
  • Impact migration of the route GET /v0/bookings/{booking_id}
    See more
    September 15, 2023
  • Migration of the route GET /v3/proposals/{proposal_id}/transport_details to the route GET /v4/proposals/{proposal_id}/transport_details
    See more
    June 1, 2025
  • Impacts migration de la route GET /v0/products/{product_id}/childcare
    See more
    September 22, 2022
  • Impact migration of the route POST /v0/proposals/{proposal_id}/alternative_transports
    See more
    September 16, 2023
  • Impact migration of the route GET /v2​/customers​/{customer_id}​/bookings​/{booking_id}
    See more
    August 10, 2023
  • Impact Migration of the route GET /v0/products/{product_id}/periods_info
    See more
    February 25, 2024
  • Impact migration of the route GET v0/customers/{customer_id}/travelers
    See more
    June 30, 2023
  • Impact migration of the route GET /v0/customers/{customer_id}/profile
    See more
    October 11, 2023

Need help with the migration?

Our developer support team is here to help you through the migration process.

Contact SupportView documentation