Introduction

Meetrip API is a RESTful web service and uses HTTP response codes to indicate API errors. The API is designed to allow application developers to check Guide availability, book a guide or a guided tour. We used HTTP verbs and support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (although you should never expose your secret API key in any public website's client-side code).

All API requests must be made over HTTP. API requests without authentication will fail.



API Reference

The meetrip API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (although you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no "switch" for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test mode credentials never hit the banking networks and incur no cost.



Authentication

Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Example Request

/api/security/api-login.{_format}

Errors

Meetrip uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with Meetrip's servers (these are rare). Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully (e.g., a card is declined), we return a 402 error code.

HTTP status code Summary

200 - OK Everything worked as expected.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided. 402 - Request Failed The parameters were valid but the request failed. 404 - Not Found The requested resource doesn't exist. 409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key). 429 - Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. 500, 502, 503, 504 - Server Errors Something went wrong on Meetrip's end. (These are rare.)

Handling Errors

Our API libraries raise exceptions for many reasons, such as a failed charge, invalid parameters, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

Sample code

{
"code": 404,
"message": "Not Found",
"errors": null,
}

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.




Versionning

When we make backwards-incompatible changes to the API, we release new, dated versions. The current version is 2016-07-06, and your version is 2016-03-07. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

All requests will use your account API settings, unless you override the API version. The changelog lists every available version. Note that events generated by API requests will always be structured according to your account API version.


Security login

Security login.

ARGUMENTS
email string Partner email.
password string Partner password.

Returns

Returns object (id, token, date) if valid identifiers was provided.

Request URL

POST /api/security/api-login.{_format}

Security logout

Security logout.

ARGUMENTS

Returns

Returns 'true' if valid identifiers was provided.

Request URL

POST /api/security/logout.{_format}

The tourist object

ATTRIBUTES
id string Tourist Id
confirmationToken string Temporary user token.
firstname string Tourist First name
lastname string Tourist Last name
fulladdress string Tourist full address
fullname string Tourist full name

Response sample code

{
"id": 7648,
"confirmationToken": "9f78f47a239bc9c9fce82458d832f7061e4c694c",
"firstname": "Alex",
"lastname": "Turchak",
"fulladdress": "Paris",
"fullname": "Alex T."
}

Registration Tourist

Registration Tourist.

ARGUMENTS
email string User Email.
plainPassword string User Password.
firstname string User First name.
lastname string User Last name.

Returns

Returns a tourist object if a valid identifier was provided.

Example Request

POST /api/v1/company/tourist-create.{_format}

Tourist authentication.

Tourist authentication.

ARGUMENTS
email string User Email.
password string User Password.

Returns

Returns a tourist object if a valid identifier was provided.

Example Request

POST /api/v1/company/tourist-auth.{_format}

Tourist logout.

Tourist logout.

ARGUMENTS
userToken string Temporary User token.

Returns

Returns a 'true' if a valid identifier was provided.

Example Request

POST /api/v1/company/tourist-auth.{_format}

Guided Tour

This is an object representing a guided tour. You can retrieve it to see details informations about a guided tour. You can also retrieve a list of guided tours, which contains a list of guided tours around a point (lat, lng) (e.g., guided tours in Paris).

You can also see calendar of this guided tour, to see when you can book it i mean, when it is available.

API Reference

The meetrip API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no "switch" for changing between modes,just use the appropriate key to perform a live or test transaction. Requests made with test mode credentials never hit the banking networks and incur no cost.

The guidedTour object

ATTRIBUTES
id string Guided Tour Id
country integer Country where the Guided Tour is made
city integer City where the Guided Tour is made
latitude string Latitude of exact point where the Guided Tour is made
longitude string Longitude of exact point where the Guided Tour is made
price string price of the Guided Tour
price_currency string price currency
media list images urls
name string Guided Tour name
description list Guided tour descriptions
product_url array url to access this guided tour on Meetrip website
book_url array url to book this guided tour on Meetrip website
description_short string short description
rating double rating value

Example Response

{
"id": "2828",
"country": 83,
"city": 1440,
"latitude": "39.57064130",
"longitude": "20.76428430",
"price": "2.00",
"price_currency": "USD",
"media": {
"id": 20282,
"size": 85799,
"type": "image/jpeg",
"media_thumb": "https://meetrip.com/uploads/media/activities/0001/29/thumb_28917_activities_small.jpeg",
"media_url": "https://meetrip.com/uploads/media/activities/0001/29/5d1eea764fd78139dfc821de4346d3cb68234346.jpeg"
},
"name": "test",
"description": {
"name": {
"de": {
"value": "test",
},
"fr": {
"value": "test",
}
},
"provide_more": {
"de": {
"value": "Beijing test",
},
"fr": {
"value": "Beijing test",
}
},
"description": {
"de": {
"value": "Deutsch description",
},
"fr": {
"value": "French description",
}
},
"product_url": "https://meetrip.com/activity/2828?utm_source=ad9d4d2bc5&utm_medium=partner&utm_campaign=2828",
"book_url": "https://meetrip.com/activity/2828?utm_source=ad9d4d2bc5&utm_medium=partner&utm_campaign=2828",
}
"description_short": "Aenean vel lorem ipsum. Sed at efficitur tellus, ac maximus sapien. Vivamus sed nunc consequat, efficitur arcu quis, aliquet libero. Maecenas in semper neque, quis porttitor mi. Pellentesque nisl nulla, ultrices egestas ex rhoncus, commodo rutrum enim. Fusce ac felis semper, tincidunt libero nec, eleifend sem. Pellentesque pretium, odio id sodales consectetur, tellus enim aliquam tellus, quis tempor justo lectus eget arcu",
"rating": 0
}

Retrieve Guided Tour

Retrieves the details of an existing guided tour. You need only supply the unique guided tour identifier.

ARGUMENTS
id string The identifier of the guided tour to be retrieved.

Returns

Returns a guided tour object if a valid identifier was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

GET /api/v1/company/activity/{id}.{_format}

List all Guided Tours

Get all guided tours with details.

GET PARAMETERS
maxResults integer How many activities to return.
firstResult integer Offset from which to start listing activities.
cityId integer The city where need to retrieve activities
countryId integer The country where need to retrieve activities
lat string Latitude of exact point where the Guided Tour is made. Requirement (-?\d+\.\d+|-?\d+).
lng string Longitude of exact point where the Guided Tour is made. Requirement (-?\d+\.\d+|-?\d+).
distance string Distance in km. Requirement (\d+\.\d+|\d+).
languages integer Languages of guide. An ids of languages.
priceMin integer Activity min price.
priceMax integer Activity max price.
specialities integer Guide speciality. An ids of speciality.
image array Will return activities and guide who have no image. Requirement (0|1).

Returns

Returns a all guided tours if a valid identifier was provided.

Request URL

GET /api/v1/company/activities.{_format}

The guide object

ATTRIBUTES
id string Guide Id
country integer Country where the Guide live
city integer City where the Guide live
latitude string Latitude of exact point of guide address
longitude string Longitude of exact point of guide address
price string guide's hourly price
price_currency string price currency
media object images object
name string Guide name
description array Guide descriptions
product_url string url to access this guided tour on Meetrip website
book_url string url to book this guided tour on Meetrip website
description_short string short description
rating double rating value

Response sample code

{
"id": "29",
"country": 73,
"city": 1,
"latitude": "48.85661400",
"longitude": "2.35222190",
"price": "20.00",
"price_currency": null,
"media": {
"id": 20282,
"size": 85799,
"type": "image/jpeg",
"media_thumb": "https://meetrip.com/uploads/media/activities/0001/29/thumb_28917_activities_small.jpeg",
"media_url": "https://meetrip.com/uploads/media/activities/0001/29/5d1eea764fd78139dfc821de4346d3cb68234346.jpeg"
},
"name": "Ekaterina E.",
"description": {
"biography": {
"fr": "Je suis une guide avec beaucoup d'expériences \r\n",
"en": "I am an experienced certified guide. \r\n"
}
},
"product_url": "http://www.meetrip.com/profile/29",
"book_url": "http://www.meetrip.com/profile/reservation/29",
"description_short": "сертифицированный гид с опытом работы",
"rating": 0
}

Retrieve Guide

Retrieves the details of an existing guide. You need only supply the unique guide identifier.

ARGUMENTS
id string The identifier of the guide to be retrieved.

Returns

Returns a guide object if a valid identifier was provided. When requesting the ID of a guide that has been deleted, a subset of the guide’s information will be returned, including a deleted property, which will be true.

Example Request

GET /api/v1/company/guide/{id}.{_format}

List all Guides

Get all guides with details.

GET PARAMETERS
maxResults integer How many Guides to return.
firstResult integer Offset from which to start listing Guides.
cityId integer The city where need to retrieve Guides
countryId integer The country where need to retrieve Guides
lat string Latitude of exact point where the Guide is made. Requirement (-?\d+\.\d+|-?\d+).
lng string Longitude of exact point where the Guide is made. Requirement (-?\d+\.\d+|-?\d+).
distance string Distance in km. Requirement (\d+\.\d+|\d+).
languages integer Languages of guide. An ids of languages.
priceMin integer Guide min price.
priceMax integer Guide max price.

Returns

Returns the all Guides if a valid identifier was provided.

Request URL

GET /api/v1/company/guides.{_format}

The reservation object

ATTRIBUTES
id string Reservation Id
user object Tourist object
type string Reservation type
state string Reservation status
createdAt string Reservation created date
dates object Reservation date (object)
unitPrice integer Total price
totalPriceTTC integer Total price

Response sample code

{
"id": 1577,
"user": {
"id": 7622,
"firstname": "turchak",
"lastname": "alex",
"fulladdress": "",
"fullname": "turchak a."
},
"type": "guide",
"guide": {
"id": 3,
"firstname": "Test t",
"lastname": "Guide g",
"fulladdress": "Sankt-Peterburg 560878124354 12 rue des bois",
"fullname": "Test t G."
},
"state": "waiting_for_payment",
"createdAt": "2017-02-03 16:41:37",
"dates": [
{
"date": "2017-02-03T00:00:00+0100",
"startTime": "2017-02-03T11:00:00+0100",
"endTime": "2017-02-03T14:00:00+0100"
}
],
"unitPrice": 2,
"totalPriceTTC": 2
}

Book a guide

ARGUMENTS
guideId integer The identifier of the guide you want to book.
startTime datetime Booking start time
endTime datetime Booking end time
meetingPlace string Booking meeting place
latitude string Meeting place coordinates latitude
longitude string Meeting place coordinates longitude
language integer Guiding Language choosen
city integer Booking city identifier
tariff integer Guide tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding
time choice duration of guiding {"1":"One hour","2":"Two hours","3":"Three hours","4":"Half day","8":"All day"}
authData object (AuthB2bUserType) ...
authData[userEmail] string User email
authData[userToken] string User token (Can get after login)

Returns

Returns a reservation object if a valid identifier was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

POST /stripe/v1/company/guides-reservation/{guideId}.{_format}

Book a guide with payment

ARGUMENTS
guideId integer The identifier of the guide you want to book.
startTime datetime Booking start time
endTime datetime Booking end time
meetingPlace string Booking meeting place
latitude string Meeting place coordinates latitude
longitude string Meeting place coordinates longitude
language integer Guiding Language choosen
city integer Booking city identifier
tariff integer Guide tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding
time choice duration of guiding {"1":"One hour","2":"Two hours","3":"Three hours","4":"Half day","8":"All day"}
paymentData object object (PaymentStripeMethodType)
paymentData[number] string Card number
paymentData[expMonth] integer Card expMonth
paymentData[expYear] integer Card expYear
paymentData[cvc] integer Card cvc
authData object (AuthB2bUserType) ...
authData[userEmail] string User email
authData[userToken] string User token (Can get after login)

Returns

Returns a reservation object if a valid identifier was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

POST /stripe/v1/company/guides-reservation-payment/{guideId}.{_format}

Book an Activity

Book an Activity

ARGUMENTS
activityId integer The identifier of the activity you want to book.
startTime datetime Booking start time
endTime datetime Booking end time
language integer Guiding Language choosen
tariff integer Guide tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding
time choice duration of guiding {"1":"One hour","2":"Two hours","3":"Three hours","4":"Half day","8":"All day"}
authData object (AuthB2bUserType) ...
authData[userEmail] string User email
authData[userToken] string User token (Can get after login)

Returns

Returns a reservation object if a valid identifier was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

POST /stripe/v1/company/activities-reservation/{activityId}.{_format}

Book a activity with payment

ARGUMENTS
activityId integer The identifier of the activity you want to book.
startTime datetime Booking start time
endTime datetime Booking end time
language integer Guiding Language choosen
tariff integer Guide tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding
time choice duration of guiding {"1":"One hour","2":"Two hours","3":"Three hours","4":"Half day","8":"All day"}
paymentData object object (PaymentStripeMethodType)
paymentData[number] string Card number
paymentData[expMonth] integer Card expMonth
paymentData[expYear] integer Card expYear
paymentData[cvc] integer Card cvc
authData object (AuthB2bUserType) ...
authData[userEmail] string User email
authData[userToken] string User token (Can get after login)

Returns

Returns a reservation object if a valid identifier was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

POST /stripe/v1/company/activities-reservation-payment/{guideId}.{_format}

Amount object

ATTRIBUTES
capacity integer Max number of persons
numberOfPersons integer Number of persons
totalPriceOriginal double Total price in guide currency
totalPriceEur double Total price in Euro
discountValue double Discount in guide currency
discountValueEur double Discount in Euro
priceWithDiscount double Price with discount in guide currency
priceWithDiscountEur double Price with discount in Euro
tariff integer Tariff id

Example Response

{
"capacity": 1,
"numberOfPersons": 1,
"totalPriceOriginal": 1,
"totalPriceEur": 1,
"discountValue": 0,
"discountValueEur": 0,
"priceWithDiscount": 1,
"priceWithDiscountEur": 1,
"tariff": 2253
}

Retrieve amount guide

ARGUMENTS
guideId integer The identifier of the guide to be retrieved.
tariff integer Guide tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding
time choice duration of guiding {"1":"One hour","2":"Two hours","3":"Three hours","4":"Half day","8":"All day"}

Returns

Returns a amount object if a valid identifier was provided.

Example Request

GET /stripe/v1/guides/amount/{guideId}.{_format}

Retrieve amount activity

ARGUMENTS
activityId integer The identifier of the activity to be retrieved.
tariff integer Activity tarif for this city and language
numberOfPersons integer Number of persons attending this Guiding

Returns

Returns a amount object if a valid identifier was provided.

Example Request

GET /stripe/v1/activities/amount/{activityId}.{_format}

Cities

The city object

ATTRIBUTES
id integer City Id
name string City name
latitude double City latitude
longitude double City longitude
description string City description
time_zone string City timezone

Example Response

{
"id": 1,
"name": "Paris",
"latitude": 48.8730359,
"longitude": 2.3121839,
"description": "Test description",
"time_zone": "Europe/France",
}

Retrieve Cities

Retrieves the details of existing cities. You need only supply the unique of cities guided tour identifier.

ARGUMENTS
ids string cities ids separated by comma ','

Returns

Returns a list of cities objects if valid identifiers was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

GET /api/v1/company/cities.{_format}

Retrieve City by name

Retrieves the details of an existing city.

ARGUMENTS
name string city name in English

Returns

Returns a city object if valid identifiers was provided.

Request URL

GET /api/v1/company/city-by-name.{_format}

Countries

The country object

ATTRIBUTES
id integer Country Id
name string Country name
isoAlpha2 string Country isoAlpha2
isoNumeric integer Country isoNumeric
currencyCode string Country currencyCode
currrencySymbol string Country currrencySymbol
phoneCode string Country phoneCode

Example Response

{
"id": 1,
"name": "Afghanistan",
"isoAlpha2": "AF",
"isoNumeric": 4,
"currencyCode": "AFN",
"currencyName": "Afghani",
"currrencySymbol": "؋",
"phoneCode": "+93"
}

Retrieve Countries

Retrieves the details of existing countries. You need only supply the unique of country identifier.

ARGUMENTS
ids string countries ids separated by comma ','

Returns

Returns a list of countries objects if valid identifiers was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

GET /api/v1/company/countries.{_format}

Retrieve Countries by slug

Retrieves the details of existing countries by slug.

ARGUMENTS
slug string countries slug

Returns

Returns a list of countries objects if valid identifiers was provided. When requesting the ID of a guided tour that has been deleted, a subset of the guided tour’s information will be returned.

Request URL

GET /api/v1/company/countries-by-slug/{slug}.{_format}

Languages

The language object

ATTRIBUTES
id integer Language Id
title string Language title

Example Response

{
"id": 1,
"title": "English",
}

Retrieve Languages

Retrieves the details of existing languages. You need only supply the unique of language identifier.

ARGUMENTS
ids string languages ids separated by comma ','

Returns

Returns a list of languages objects if valid identifiers was provided.

Request URL

GET /api/v1/company/languages.{_format}

Specialities

The speciality object

ATTRIBUTES
id integer Speciality Id
name string Speciality name
icon object images object

Example Response

{
"id": 1,
"name": "Art/Musee",
"icon": {
"id": 20282,
"size": 85799,
"type": "image/jpeg",
"media_thumb": "https://meetrip.com/uploads/media/activities/0001/29/thumb_28917_activities_small.jpeg",
"media_url": "https://meetrip.com/uploads/media/activities/0001/29/5d1eea764fd78139dfc821de4346d3cb68234346.jpeg"
}
}

Retrieves Specialities

Retrieves the details of existing specialities. You need only supply the unique of specialities identifier.

ARGUMENTS
ids string specialities ids separated by comma ','

Returns

Returns a list of specialities objects if valid identifiers was provided.

Request URL

GET /api/v1/company/specialities.{_format}

The guide object

ATTRIBUTES
cariboo object Guide object with full data about him
firstname string Guide First name
lastname string Guide Last name
languagesName string Languages with owns guide
minTarif double Guide hourly min tariff
maxTarif double Guide hourly max tariff
convertedMinTariff double Guide hourly converted min tariff
convertedMaxTariff double Guide hourly converted max tariff
currencyCode string Price currency
rate double Guide hourly rate
avgRating string Guide rating

Response sample code

{
"cariboo": {...},
"firstname": "withdrawcariboo",
"lastname": "withdrawcariboo",
"languagesName": "English",
"minTarif": 10,
"maxTarif": 10,
"convertedMinTariff": 10,
"convertedMaxTariff": 10,
"currencyCode": "EUR",
"rate": 10,
"avgRating": ""
}

Retrieves Cariboo Guides

Retrieves the details of an existing guide. You need only supply the unique guide identifier.

ARGUMENTS
username string User username from object Cariboo

Returns

Returns a cariboo guide objects if valid identifiers was provided.

Request URL

GET /api/v1/company/cariboo-guide/{username}.{_format}

List Cariboo Guides

List Cariboo guides.

ARGUMENTS
city string The city where need to retrieve guides. Requirement [a-zA-Z\s]+
country string The country where need to retrieve guides. Requirement [a-zA-Z\s]+
languages string The languages where need to retrieve guides. Requirement [a-zA-Z\s]+
priceMin double Price min. Requirement (\d+).
priceMax double Price max. Requirement (\d+).

Returns

Returns a list of cariboo guides objects if valid identifiers was provided.

Request URL

GET /api/v1/company/cariboo-guides.{_format}

The event object

ATTRIBUTES
id string Event id
max_size integer Event group max size
current_size integer Number of people in group on it moment
title string Event title
event_date Datetime (object) Event date start
price_per_person object Price and currency for event
visitProposition object Event data: image, description, language...

Response sample code

{
"id": 261,
"max_size": 10,
"current_size": 0,
"title": "Bordeaux classique",
"event_date": "2017-10-10T14:30:00+0200",
"price_per_person": ▿{
"amount": 15,
"currency": {
"code": "EUR",
"symbol": "€",
"name": "Euro"
}
},
"visitProposition": ▿{
"id": 11844,
"cover": {
"path": "http://test.com/Resources/public/images/AllPagers/default-cover.jpg"
},
"name": "Bordeaux classique",
"description": "Test description",
"language": {
"short": "fr",
"language": "French"
}
}
}

List Cariboo Events

List Cariboo events.

ARGUMENTS
city string The city where need to retrieve events. Requirement [a-zA-Z\s]+
languages string The languages where need to retrieve events. Requirement [a-zA-Z\s]+

Returns

Returns a list of cariboo guides objects if valid identifiers was provided.

Request URL

GET /api/v1/company/cariboo-events.{_format}

The guide reservation object

ATTRIBUTES
id integer Reservation id.
booker object Tourist object.
cariboo object Guide object
group_size integer Group size
flexibility string The interval in days. For example tourist select date 24-02-2017 and flexibility +1 day guide can create on 24 or 25 Feb.
preferred_date string Reservation preferred date.
duration string Reservation duration (minutes).
booking_date string Reservation booking date which select guide.
status string Reservation status.
createdAt string Reservation created datetime.
isCariboo boolean Reservation guide is cariboo.

Response sample code

{
"id": 1001,
"booker": {...}
"cariboo": {...}
"group_size": 1,
"flexibility": "1",
"preferred_date": "2017-02-25T00:00:00+0100",
"duration": 60,
"booking_date": "2017-02-15T17:41:49+0100",
"status": "onhold",
"createdAt": "2017-02-15T17:41:49+0100",
"isCariboo": true
}

Book Cariboo Guides

Book Cariboo guide.

ARGUMENTS
duration integer Duration. Requirement {"60","90","120",...}
groupSize integer The group size.
preferredDate string Book date. Requirement dd/MM/yyyy
bookerPhone string Phone number
requestMessage string Message to guide.
bookerPhone string Phone number
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns objects if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-guide-reservation/{username}.{_format}

Accept Guide Reservation

Accept guide Reservation.

ARGUMENTS
number string Card number
expMonth integer Card expMonth
expYear integer Card expYear
cvc integer Card cvc
address object object (CaribooBookingAddressType)
address[line1] string Tourist address.
address[line2] string Tourist address (optional).
address[city] string Tourist city.
address[state] string Tourist state.
address[postalCode] string Tourist post code.
address[country] string Tourist country.
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns Reservation payment object if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-accept-reservation/{reservationId}.{_format}

The guide reservation payment object

ATTRIBUTES
id integer Payment id.
total_cost object Total price object.
guide_cost object Guide total price object.
cariboo_fee object Cariboo total price object.
promo_value object Promo total sum object.
currency string Currency.
address object Tourist address.
created_at string Datetime creation of payment.

Response sample code

{
"id": 210,
"total_cost": {...}
"guide_cost": {...}
"cariboo_fee": {...}
"promo_value": {...}
"currency": "USD",
"address": ⊕{...}
"created_at": "2017-02-16T16:43:28+0100"
}

Decline Guide Reservation

Decline guide reservation.

ARGUMENTS
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns string "success" if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-decline-reservation/{reservationId}.{_format}

Get Tourist Reservations

Get Tourist Reservations.

ARGUMENTS
userEmail string User email.
userToken string User token.

Returns

Returns Reservation objects if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-user-reservations.{_format}

Create Event Reservation

Create Event Reservation.

ARGUMENTS
number string Card number
expMonth integer Card expMonth
expYear integer Card expYear
cvc integer Card cvc
event object object (CaribooCompanyEventType)
event[groupSize] string Group size.
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns Reservation objects if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-event-reservation/{eventId}.{_format}

The message object

ATTRIBUTES
content string Message text.
sender object Tourist address.
created_at string Datetime creation of message.

Response sample code

{
"content": "Hello, how are you?",
"sender": {...}
"sent_time": "2017-02-16T15:29:44+0100"
}

Get Tourist Messages Reservations

Get Tourist Messages Reservations.

ARGUMENTS
reservationId integer Reservation id.
userEmail string User email.
userToken string User token.

Returns

Returns Message objects if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-user-messages/{reservationId}.{_format}

Create Tourist Messages Reservations

Create Tourist Messages Reservations.

ARGUMENTS
reservationId integer Reservation id.
userEmail string User email.
userToken string User token.
message string Message text.

Returns

Returns 'success' if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-guide-message/{reservationId}.{_format}

The event message object

ATTRIBUTES
id integer Conversation id.
message array Message data.
last_action Datetime Last message date
created_at Datetime Datetime creation of message.

Response sample code

{
"id": 371,
"messages": [
{
"sender": ⊕{...}
"content": "Hi",
"last_action": "2017-10-03T15:42:48+0200",
"created_at": "2017-10-03T15:42:48+0200"
},
{ "sender": ⊕{...}
"content": "Hi how are you?",
"last_action": "2017-10-03T16:15:36+0200",
"created_at": "2017-10-03T16:15:36+0200"
},
],
"last_action": "2017-08-25T14:14:04+0200",
"created_at": "2017-08-25T14:14:04+0200"
}

Get Messages for event

Get Messages for event.

ARGUMENTS
eventId integer Event id.
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns Message objects if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-user-messages/{reservationId}.{_format}

Create Tourist Messages for Event

Create tourist messages for event.

ARGUMENTS
eventId integer Event id.
message string Message text.
authData object object (AuthB2bUserType)
authData[userEmail] string User email.
authData[userToken] string User token.

Returns

Returns 'success' if valid identifiers was provided.

Request URL

POST /api/v1/company/cariboo-event-message/{eventId}.{_format}

Discounts

COMING SOON

API Reference

COMING SOON

Invoices

COMING SOON

API Reference

COMING SOON

Subsciptions

COMING SOON

API Reference

COMING SOON