booking_creation

Get a list of saved proposals

get/v0/proposals/saved

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/proposals/saved
  • Auth: one of:
    • OpenID Connect (https://accounts.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)
    • OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Query parameters

product_idstring

ClubMed Product identifier

Example:MPAC
customer_last_namestring
Example:Smith
min_departure_datestring date

min departure date

Example:2022-04-15
max_departure_datestring date

max departure date

Example:2022-04-15
min_reservation_datestring date

minimum reservation date of the proposal Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
max_reservation_datestring date

maximum reservation date of the proposal Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
discount_idstring

Discount that must be present on the proposal

view'SELLER' | 'AGENCY' | 'NETWORK'

Requested view for Partners only. SELLER means you want your seller saved proposals. AGENCY means you want your agency saved proposals. NETWORK means you want your network saved proposals. Possible values: SELLER, AGENCY, NETWORK. This parameter is optional.

limitinteger

Maximum rows count per page

pageinteger

Requested page number, starting from 1 (default: 1)

Headers

x-api-keystring required

Api_key provided by ClubMed API team

authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

Response

ok

idstring required

Proposal identifier

product_idstring required

ClubMed Product identifier

product_labelstring
customer_idstring required

Customer ID of the main attendee

gm_numberstring nullable

great member number

civilitystring

main attendee's civility

first_namestring

main attendee's first name

last_namestring

main attendee's last name

auto_optionable_status'NONE' | 'SCHEDULED' | 'CONVERTED' | 'FAILED' required

Automatic Option Status: Set as NONE when the proposal is not tagged as to be converted automatically. Displayed as SCHEDULED when the proposal is tagged as to be converted automatically. CONVERTED indicates that the proposal was tagged as to be converted and has been done successfully. On the contrary, FAILED indicates that the proposal was tagged as to be converted but has failed.

adults_countinteger

adult attendees number

children_count0

children attendees number

with_transportboolean

Is transport included into the proposal

resort_arrival_datestring date

Arrival date in the resort. Format YYYY-MM-DD

last_modification_datestring date

Proposal's last modification date

creation_datestring date nullable

Proposal's creation date

reservation_datestring date nullable

Proposal's reservation date

Example response

[
  {
    "id": "123456",
    "product_id": "MPAC",
    "product_label": "Chamonix Mont-Blanc",
    "customer_id": "123456789",
    "gm_number": "123456789",
    "civility": "MR",
    "first_name": "Michael",
    "last_name": "Jackson",
    "auto_optionable_status": "NONE",
    "discounts": [
      {
        "id": "LMO"
      }
    ],
    "adults_count": 4,
    "children_count": 4,
    "resort_arrival_date": "2022-04-15",
    "last_modification_date": "2022-04-15",
    "creation_date": "2022-04-15",
    "reservation_date": "2022-04-15"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.