The goal of this API is to allow partners to send reservations and customers data (and updates) to the Experience Hotel system and to retrieve changes from experience hotel.
In order to access the API, you will need a client-token and one or more hotel-token
The Experience CRM relies on being synchronized with the hotel PMS. We send communications to guests before their arrival, during their stay, and after. Thus, it is essential that we are kept up to date with cancellations, new reservations and modifications.
The optimal scenario is to be updated after each change, whether it is a booking change, or a customer property change(like a new last name, or new phone number for example).
To summarize, what is expected on this API is
\nThe Bearer Token is composed of:
\nYour partner token will be the same regardless of the hotel involved with your call. The hotel token will be different for each hotel.
\nFormat: partner_token:hotel_token
L'objectif de cette API est de permettre aux partenaires d'envoyer des données sur les réservations et les clients (et des mises à jour) au système Experience Hotel et de récupérer les modifications depuis Experience Hotel.
Afin d'accéder à l'API, vous aurez besoin d'un client-token et d'un ou plusieurs hotel-token.
Le CRM d'Experience repose sur la synchronisation avec le PMS de l'hôtel. Nous envoyons des communications aux clients avant leur arrivée, pendant leur séjour et après. Il est donc essentiel que nous soyons tenus au courant des annulations, des nouvelles réservations et des modifications.
\nLe scénario optimal est d'être mis à jour après chaque modification, qu'il s'agisse d'un changement de réservation ou d'un changement d'information du client (comme un nouveau nom de famille ou un nouveau numéro de téléphone par exemple).
\nEn résumé, ce que l'on attend sur cette API :
\nLe Bearer Token est composé de :
\nVotre token partenaire sera le même quel que soit l'hôtel concerné par votre appel. Le token de l'hôtel sera différent pour chaque hôtel.
\nFormat : partner_token:hotel_token
In the case of a booking update, it is essential to return ALL the attributes of the booking & customer objects. If some attributes are not included in an update they will be set to NULL or deleted.
\n*Mandatory fields
\n| Field | Type | Description |
|---|---|---|
| reference\\\\\\\\\\* | string | Unique reference of the booking |
| status\\\\\\\\\\* | string | Status of the booking. valid, option, cancelled |
| creation | string ($ISO 8601) | Date the booking was created (optional) |
| arrival\\\\\\\\\\* | string ($ISO 8601) | Date the client will arrive at the hotel |
| departure\\\\\\\\\\* | string ($ISO 8601) | Date the client will leave the hotel |
arrival_time | string | Format H:i:s (Hour:Minutes:Secondes \"14:50:00\") |
| ratecode | string | ratecode of the booking (optional) |
| sourcecode | string | source of the booking (optional) |
| segmentcode | string | code used for the segmentation of the booking (optional) |
| totalamount | number ($float) | Price of the booking including taxe (optional) |
| currency | string ($ISO 4217) | currency use for the price (optional) |
| arrival_time | string ($time hh:mm:ss) | Arriving time of the client (optional) |
| adult_count | number | number of adult (optional) |
| child_count | number | number of children (optional) |
| infant_count | number | number of infant (optional) |
| extra_attributes | Object | Array of key/value to be associated to the booking (optional) |
xp-company | string | Company of the guest. This field must be inside extra_attributes |
| rooms | array | Rooms associated with the booking (optional) |
| customer | Object | Customer associated with the booking |
| Field | Type | Description |
|---|---|---|
| number | string | Unique number of the room (can be empty) |
| name | string | Category name for the room, can be unique or not (optional) |
| type | string | Category code of the room, can be unique or not (optional) |
| Field | Type | Description |
|---|---|---|
| reference\\\\\\\\\\* | string | Unique identifier of the customer |
| title | string | Title or civility of the customer (optional) |
| firstname | string | Firstname of the customer (optional) |
| lastname | string | Lastname of the customer (optional) |
string | Email of the customer. (optional) | |
| phone | string | Phone number (optional) |
| birthdate | string ($ISO 8601) | Birthdate of the customer (optional) |
| country | string ($ISO 3166-1 alpha-2) | Country of the customer (optional) |
| language | string ($ISO 639-1) | Language of the customer. If not present, the language can be deduce from the country (optional) |
address_street_number_and_name | string | Customer's address street and number |
address_postal_code | string | Customer's address postal code (optional) |
address_state | string | Customer's address state (optional) |
address_city | string | Customer's address city (optional) |
nationality | string ($ISO 3166-1 alpha-2) | Nationality of the customer (optional) |
identity_document_number | string | Number of the identity document (ID, passport) |
| extra_attributes | Object | Array of key/value to be associated to the customer (optional) |
*Mandatory fields
\n| Field | Type | Description |
|---|---|---|
| reference\\\\* | string | Unique identifier of the customer |
| title | string | Title or civility of the customer (optional) |
| firstname | string | Firstname of the customer (optional) |
| lastname | string | Lastname of the customer (optional) |
| string | Email of the customer. (optional) | |
| phone | string | Phone number (optional) |
| birthdate | string ($ISO 8601) | Birthdate of the customer (optional) |
| country | string ($ISO 3166-1 alpha-2) | Country of the customer (optional) |
| language | string ($ISO 639-1) | Language of the customer. If not present, the language can be deduce from the country (optional) |
| address_street_number_and_name | string | Customer's address street and number (optional) |
| address_postal_code | string | Customer's address postal code (optional) |
| address_state | string | Customer's address state (optional) |
| address_city | string | Customer's address city (optional) |
| nationality | string ($ISO 3166-1 alpha-2) | Nationality of the customer (optional) |
| identity_document_number | string | Number of the identity document (ID, passport) |
| extra_attributes | Object | Array of key/value to be associated to the customer (optional) |
Experience CRM will get update on customers information based on their interactions. These 2 way methods allow you to be updated as soon as the event occurs.
\nReturn the list of booking event which contain the booking and customer changes from different events of Experience Hotel.
The two parameters in the url are the start-date and end-date.
Return the list of booking event that occured after a given ID. This way you can use the last ID retrieved.
\nParameter : event ID
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"lkjfqmnfqznefqeqrezohrqeihroirqzhoobysoysggto:6546rgd46d81f6s688s1f68168f1f6s81fse68"}]},"isInherited":true,"source":{"_postman_id":"86fe6f6a-370f-4e44-adbf-99fe36e0b4af","id":"86fe6f6a-370f-4e44-adbf-99fe36e0b4af","name":"Experience Engine API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","xp-store-bookings","events","list-after-event-id","123456"],"host":["interface","experience-hotel","com"],"query":[],"variable":[]}},"response":[{"id":"ee2d6f7e-fbb2-476d-afe7-a8cee6fe747e","name":"2 way - events list","originalRequest":{"method":"GET","header":[],"url":"https://interface.experience-hotel.com/api/xp-store-bookings/events/list/2022-03-29/2022-03-30"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 20 Feb 2022 10:07:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Remaining","value":"5999"},{"key":"Vary","value":"Authorization"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=bsNek7RgDpDqiKP4MbJPaoB7fC57UZcgskub8TbLdZgpQS%2F0%2BYWNpj4lExjzjuW2QTh%2BFtHuYkB1pAQ8ewIlUcT3QDZ%2BpWKYX%2BvDmGKkyz5ktMzCVAQz7bf0V0CV0FWLK0IpMAzmxo3eE6mFb%2F27o%2BCe\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6e06ee0e6812e0ee-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": {\n \"event_ids\": [\n 2068416,\n 2760370,\n 2760372,\n 2760408,\n 2760447,\n 2760514,\n 2760526,\n 2760548,\n 2761263,\n 2761265,\n 2761280,\n 2761287,\n 2761318,\n 2761321\n ],\n \"server_timestamp\": 1645351667\n }\n}"}],"_postman_id":"538dce25-c762-4b7c-8669-0831f24e1d3a"},{"name":"2 way - event details","id":"61c8c179-53f5-4acf-82a7-8fc1b0b839a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://interface.experience-hotel.com/api/xp-store-bookings/events/details?event_ids[]=2068416&event_ids[]=2761321","description":"Return the customers changes details.
\nEvent type availble :
\n