API docs by Redocly

travelsApi API Documentation (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation and interface contract for the travelsApi, the API responsible for the management (creation, publication, reservation ...) of a trip.

Trips

addTrip

Creation of a trip as a business object.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a tour.

reference
string

Reference of the tour.

establishmentId
required
string

Technical id of the establishment that owns the tour.

Array of objects (pictures)

List of photos representing the tour.

title
required
string

Title of the tour.

smallDescription
string

A brief description of the listing.

detailedDescription
string

A detailed description of the listing.

Array of objects (tripProgramDetails)

The details of a tour's program.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

deleteMultipleTrips

Logical deletion of trips.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
listIds
required
Array of strings

List of trip identifiers.

Responses

Request samples

Content type
application/json
{
  • "listIds": [
    ]
}

Response samples

Content type
application/json
{ }

listTrip

List trips.

query Parameters
establishment-id
required
string

Technical identifier of the establishment that owns the asset.

currentPage
integer >= 0

Current page number; do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getTrip

Retrieve a trip by its id.

path Parameters
trip-id
required
string

Technical identifier of the trip.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

putTrip

Update a trip.

path Parameters
trip-id
required
string

Technical identifier of the trip.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a tour.

reference
string

Reference of the tour.

establishmentId
required
string

Technical id of the establishment that owns the tour.

Array of objects (pictures)

List of photos representing the tour.

title
required
string

Title of the tour.

smallDescription
string

A brief description of the listing.

detailedDescription
string

A detailed description of the listing.

Array of objects (tripProgramDetails)

The details of a tour's program.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

deleteTrip

Delete a trip.

path Parameters
trip-id
required
string

Technical identifier of the trip.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }

TripPublications

listPublications

List publications.

query Parameters
destination
string

A destination city.

start-date
string <date>

Stay start date.

end-date
string <date>

Stay end date.

adultTravelers
integer

Number of travelers (adults).

childTravelers
integer

Number of travelers (children).

babiesTravelers
integer

Number of travelers (babies).

maxPrice
integer <int64>

Maximum price.

minPrice
integer <int64>

Minimum price.

currentPage
integer >= 0

Current page number; do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

establishmentIds
string
Example: establishmentIds=id1,id2,id3

Filter by establishment identifiers (comma-separated).

publicationIds
string
Example: publicationIds=id1,id2,id3

Filter by publication identifiers (comma-separated).

status
string (publicationStatus)
Enum: "PUBLISHED" "ARCHIVED" "WAITING_FOR_APPROVAL" "DRAFTS"

The listing status.

search
string
Example: search=Marrakech

Free-text search on reference, title, or destination.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

archivePublications

Archive all publications.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
tripIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tripIds": [
    ]
}

Response samples

Content type
application/json
true

getPublication

Retrieve a publication by its id.

path Parameters
publication-id
required
string

Technical identifier of the publication.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ],
  • "trip": {
    },
  • "links": [
    ]
}

putPublication

Update a publication.

path Parameters
publication-id
required
string

Technical identifier of the publication.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a trip publication.

tripId
required
string

Technical id of the trip to publish.

status
string (publicationStatus)
Enum: "PUBLISHED" "ARCHIVED" "WAITING_FOR_APPROVAL" "DRAFTS"

The listing status.

childsMaxAge
required
integer

The maximum age to benefit from child pricing.

babiesMaxAge
required
integer

The maximum age to benefit from baby pricing.

required
Array of objects (tripDate)

List of proposed dates for a tour.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ],
  • "trip": {
    },
  • "links": [
    ]
}

deletePublication

Delete a publication.

path Parameters
publication-id
required
string

Technical identifier of the publication.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }

publishPublication

Publish a publication.

path Parameters
publication-id
required
string

Technical identifier of the publication.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
true

TripPublicationsManagePlace

managePlaces

Manage the number of spots in a publication.

path Parameters
publication-id
required
string

Technical identifier of the publication.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
tripDateId
string

Technical id of the tour date chosen at the time of booking.

adultPlacesCount
integer

The number of adult seats (positive to make seats available again, negative otherwise).

childPlacesCount
integer

The number of child seats (positive to make seats available again, negative otherwise).

babiesPlacesCount
integer

The number of baby seats (positive to make seats available again, negative otherwise).

Responses

Request samples

Content type
application/json
{
  • "tripDateId": "string",
  • "adultPlacesCount": 0,
  • "childPlacesCount": 0,
  • "babiesPlacesCount": 0
}

Response samples

Content type
application/json
{ }

TripPricing

getTripPricing

Retrieve the pricing details for a trip.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a booking.

publicationId
required
string

Technical id of the purchased publication.

required
Array of objects (client)

List of clients who will undertake the trip.

transactionId
string

Technical id of the transaction associated with the booking.

tripDateId
required
string

Technical id of the tour date chosen at the time of booking.

reference
string

Booking reference, generated automatically and uniquely identifying a booking for the client.

status
string (reservationStatus)
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

The booking status.

Array of objects (activityInput)

The list of activities purchased for a tour.

Array of objects (optionInput)

The list of options purchased for a tour.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "travelPricingPerPerson": {
    },
  • "travelTotalPriceWithoutCharge": {
    },
  • "serviceFees": {
    },
  • "paymentFees": {
    },
  • "activitiesTotalPrice": {
    },
  • "optionsTotalPrice": {
    },
  • "travelTotalPrice": {
    }
}

TripReservations

addReservation

Book an asset.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a booking.

publicationId
required
string

Technical id of the purchased publication.

required
Array of objects (client)

List of clients who will undertake the trip.

transactionId
string

Technical id of the transaction associated with the booking.

tripDateId
required
string

Technical id of the tour date chosen at the time of booking.

reference
string

Booking reference, generated automatically and uniquely identifying a booking for the client.

status
string (reservationStatus)
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

The booking status.

Array of objects (activityInput)

The list of activities purchased for a tour.

Array of objects (optionInput)

The list of options purchased for a tour.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

listReservations

List reservations.

query Parameters
publication-id
string

Technical identifier of the publication.

establishmentIds
string

Technical identifiers of the establishment that owns the publication.

owner-id
string

Technical identifier of the customer who made the reservation.

search
string
Example: search=RES123456

Free-text search on the reservation reference and booking reference.

status
string (reservationStatus)
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

The booking status.

currentPage
integer >= 0

Current page number; do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getReservation

Retrieve a reservation by its id.

path Parameters
reservation-id
required
string

Technical identifier of the reservation.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

putReservation

Update a reservation.

path Parameters
reservation-id
required
string

Technical identifier of the reservation.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a booking.

publicationId
required
string

Technical id of the purchased publication.

required
Array of objects (client)

List of clients who will undertake the trip.

transactionId
string

Technical id of the transaction associated with the booking.

tripDateId
required
string

Technical id of the tour date chosen at the time of booking.

reference
string

Booking reference, generated automatically and uniquely identifying a booking for the client.

status
string (reservationStatus)
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

The booking status.

Array of objects (activityInput)

The list of activities purchased for a tour.

Array of objects (optionInput)

The list of options purchased for a tour.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "reference": "string",
  • "status": "CONFIRMED",
  • "activitiesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

deleteReservation

Delete a reservation.

path Parameters
reservation-id
required
string

Technical identifier of the reservation.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }

Opinions

addOpinion

Add a review on a listing.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a review.

tripPublicationId
required
string

Technical id of the publication concerned by the review, required for (post).

globalMark
required
integer [ 1 .. 5 ]
Default: 1

Overall rating given by the client on the listing.

complianceMark
required
integer [ 1 .. 5 ]
Default: 1

Compliance rating of the listing given by the client.

qualityServiceMark
required
integer [ 1 .. 5 ]
Default: 1

Service quality rating given by the client on the listing.

priceQualityMark
required
integer [ 1 .. 5 ]
Default: 1

Value for money rating given by the client on the listing.

comment
required
string [ 10 .. 200 ] characters

The comment left by the client on the listing.

createdDate
string <date-time>

Creation date of the review.

ownerId
string

The owner of the review.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "ownerId": "string",
  • "links": [
    ]
}

listOpinions

List reviews.

query Parameters
publication-id
required
string

Technical identifier of the publication.

currentPage
integer >= 0

Current page number; do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": {
    }
}

getOpinion

Retrieve a review by its id.

path Parameters
opinion-id
string

Technical identifier of the review.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "ownerId": "string",
  • "links": [
    ]
}

putOpinion

Update a review.

path Parameters
opinion-id
required
string

Technical identifier of the review.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique id generated automatically that identifies a review.

tripPublicationId
required
string

Technical id of the publication concerned by the review, required for (post).

globalMark
required
integer [ 1 .. 5 ]
Default: 1

Overall rating given by the client on the listing.

complianceMark
required
integer [ 1 .. 5 ]
Default: 1

Compliance rating of the listing given by the client.

qualityServiceMark
required
integer [ 1 .. 5 ]
Default: 1

Service quality rating given by the client on the listing.

priceQualityMark
required
integer [ 1 .. 5 ]
Default: 1

Value for money rating given by the client on the listing.

comment
required
string [ 10 .. 200 ] characters

The comment left by the client on the listing.

createdDate
string <date-time>

Creation date of the review.

ownerId
string

The owner of the review.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "ownerId": "string",
  • "links": [
    ]
}

deleteOpinion

Delete a review.

path Parameters
opinion-id
required
string

Technical identifier of the review.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }