API Motor de reservas Transfers

Introducción

Bienvenido a la API de transfers del motor de reservas de Mybooking.

Este API tiene tiene la funcionalidad necesaria para registrar una reserva de una empresa de transfers.

Está diseñada de forma que se pueda utilizar tanto desde el navegador con JAMStack (opens new window) como desde su lenguaje preferido en el lado del servidor.

URL Base

https://micuenta.mybooking.es

Lugares origen y destino

GET Lugares de origen

GET /api/booking-transfer/frontend/origin-points

Obtiene los lugares de origen

Query String

Parámetro	Descripción	Detalle
lang	Idioma	Código ISO 639-1 (en,es,it,...)	Opcional
term	Text búsqueda	Texto para buscar un lugar	Opcional

Resultado

Success

TIP

200

Retorna un Array, con los lugares de origen para realizar el transfer.

Object	Descripción
transfer_point		array[object]
	id	Number
	name	String
	point_type	String	location, airport, harbor, bus_station, train_station

[
  {
    "id": 1,
    "name": "Menorca Airport",
    "point_type": "airport"
  }
]

GET Lugares de destino

GET /api/booking-transfer/frontend/destination-points

Obtiene los lugares de destino

Query String

Parámetro	Descripción	Detalle
origin_point_id	Lugar de origen	El identificador del lugar de origen	Requerido
lang	Idioma	Código ISO 639-1 (en,es,it,...)	Opcional
term	Text búsqueda	Texto para buscar un lugar	Opcional

Resultado

Success

TIP

200

Retorna un Array, con los lugares de destino para realizar el transfer.

transfer_point	Campo	array[object]	Lugar de transfer
	id	Number
	name	String
	point_type	String	location, airport, harbor, bus_station, train_station

[
  {
    "id": 2,
    "name": "Hotel Menorca",
    "point_type": "location"
  }
]

Proceso de reserva

POST Crear carrito de reserva

POST /api/booking-transfer/frontend/shopping-cart

Inicia el proceso de reserva seleccionado la fecha y hora, los lugares de origen, destino y el número de personas

Query String

Parámetro	Descripción	Detalle
lang	Idioma	Código ISO 639-1 (en,es,it,...)	Opcional
include_products	Incluye vehículos y tarifas	Boolean	Opcional
include_extras	Incluye extras y tarifas	Boolean	Opcional

Request Body

Parámetro	Descripción	Detalle
date	Fecha	dd/mm/yyyy	Obligatorio
time	Hora	hh:MM	Obligatorio
origin_point_id	Lugar de origen	Identificador (Número)	Obligatorio
destination_point_id	Lugar de destino	Identificador (Número)	Obligatorio
rountrip	¿Ida y vuelta?	false (sólo ida) true (ida y vuelta)	Obligatorio
number_of_adults	Número de adulto	Número	Obligatorio
number_of_children	Número de niños	Número	Obligatorio
number_of_infants	Número de bebés	Número	Obligatorio
return_date	Fecha	dd/mm/yyyy	Obligatorio
return_time	Hora	hh:MM	Obligatorio
return_origin_point_id	Lugar de origen	Identificador (Número)	Obligatorio
return_destination_point_id	Lugar de destino	Identificador (Número)	Obligatorio

{
  "date": "17/08/2019",
  "time": "10:00",
  "origin_point_id": 1,
  "destination_point_id": 2,
  "rountrip": false,
  "number_of_adults": 2,
  "number_of_children": 1,
  "number_of_infants": 0 
}

Resultado

Success

TIP

200

shopping_cart		object[object]	Carrito de la compra
	free_access_id	String	Identificador del carrito para múltiples peticiones
	date	String YYYY-MM-DD	Fecha
	time	String HH:MM	Hora
	origin_point_id	Number	Identificador del punto de origen
	origin_point_name	String	Nombre del punto de origen
	origin_point_name_customer_translation	String	Nombre del punto de origen
	destination_point_id	Number	Identificador del punto de origen
	destination_point_name_customer_translation	String	Nombre del punto de origen
	round_trip	Boolean	Sólo ida (false) Ida y vuelta (true)
	return_date	String YYYY-MM-DD	Fecha de la vuelta
	return_time	String HH:MM	Hora de la vuelta
	return_origin_point_id	Number	Identificador del punto de origen (vuelta)
	return_origin_point_name_customer_translation	String	Nombre del punto de origen (vuelta)
	return_destination_point_id	Number	Identificador del punto de origen (vuelta)
	return_destination_point_name_customer_translation	String	Nombre del punto de origen (vuelta)
	item_id	Number	Identificador del vehículo
	item_name	String	Nombre del vehículo
	item_name_customer_translation	String	Nombre del vehículo (traducción idioma cliente)
	item_photo	String	Path con la foto del vehículo (tamaño medio)
	item_full_photo	String	Path con la foto del vehículo (tamaño completo)
	number_of_adults	Integer	Número de adultos
	number_of_children	Integer	Número de niños
	number_of_infants	Integer	Nombre de bebés
	item_cost	String (amount)	Importe del vehículo
	extras_cost	String (amount)	Importe de los extras
	total_cost	String (amount)	Importe total
	extras	array[object]	Extras
	- extra_id	Integer	Identificador del extra
	- extra_name	String	Nombre del extra
	- extra_name_customer_translation	String	Nombre del extra (traducción idioma cliente)
	- extra_photo	String	URL foto extra
	- extra_photo_full	String	URL foto extra (tamaño completo)
	- quantity	Integer	Número de unidades

products		array[object]	Vehículos y tarifas
	id	Number	Identificador del vehículo
	name	String	Nombre del vehículo
	price	String (amount)	Coste
	available	Boolean	Si está disponible

extras		array[object]	Vehículos y tarifas
	id	Number	Identificador del vehículo
	name	String	Nombre del vehículo
	unit_price	String (amount)	Coste unitario
	max_quantity	Number	Cantidad máxima
	max_sellable_quantity	Number	Cantidad máxima que puede venderse

{  
            "products": [
                {"id": 1,
                 "name": "Traslado VIP 2/4 plazas",
                 "price": "121.00",
                 "available": true},
                {"id": 2,
                 "name": "Traslado VIP Minivan 7/8 plazas",
                 "price": "242.00",
                 "available": true},
                {"id": 3,
                 "name": "Traslado GRUPOS Bus/Minubus",
                 "price": "363.00",
                 "available": true},                       
             ],
             "extras": [
                {"id": 1,
                 "name": "Servicio maletas",
                 "max_quantity": 3,
                 "max_sellable_quantity": 3,
                 "unit_price": "5.00",
                }
             ],
             "shopping_cart": {
                "free_access_id": "WSYVCn3GBAsEJAv3q",
                "lang": "es",
                "date": "2021/07/01",
                "time": "10:00",
                "origin_point_id": 1,
                "origin_point_name": "Aeropuerto Barajas T4",
                "origin_point_name_customer_translation": "Aeropuerto Barajas T4",
                "destination_point_id": 2,
                "destination_point_name": "Puy du fou",
                "destination_point_name_customer_translation": "Puy du fou",
                "round_trip": true,
                "return_date": "2021/07/01",
                "return_time": "10:00",
                "return_origin_point_id": 1,
                "return_origin_point_name": "Aeropuerto Barajas T4",
                "return_origin_point_name_customer_translation": "Aeropuerto Barajas T4",
                "return_destination_point_id": 2,
                "return_destination_point_name": "Puy du fou",
                "return_destination_point_name_customer_translation": "Puy du fou",
                "item_id": 1,
                "item_name": "Traslado VIP 2/4 plazas",
                "item_name_customer_translation": "Traslado VIP 2/4 plazas",
                "item_photo": null,
                "item_photo_full": null,
                "number_of_adults": 3,
                "number_of_children": 0,
                "number_of_infants": 0,
                "item_cost": "121.00",
                "extras_cost": "0.00",
                "total_cost": "121.00",
                "extras": [
                  {"extra_id": 1,
                   "extra_name": "Servicio maletas",
                   "extra_name_customer_translation": "Servicio maletas",
                   "extra_photo": null,
                   "extra_photo_full": null,
                   "quantity": 1,
                   "extra_unit_cost": "5.00",
                   "extra_cost": "5.00" }
                ]                
             } 
          }

POST Cambiar datos del carrito de reserva

POST /api/booking-transfer/frontend/shopping-cart/{free_access_id}

Cambio los datos del proceso de reserva de un transfer: la fecha y hora, los lugares de origen, destino y el número de personas

Resultado

Success

TIP

200

Resultado

Utiliza el mismo esquema que el proceso de creación del carrito de reserva

Son los mismos datos que el proceso de creación del carrito de reserva

Error

WARNING

404 Carrito de reserva no existe

GET Obtener carrito de reserva

GET /api/booking-transfer/frontend/shopping-cart/{free_access_id}

Obtiene el carrito de la resera a partir de su identificador

Parámetros del path

Parámetro	Descripción	Detalle
free_access_id	Identificador del carrito	String	Requerido

Query String

Parámetro	Descripción	Detalle
lang	Idioma	Código ISO 639-1 (en,es,it,...)	Opcional
include_products	Incluye vehículos y tarifas	Boolean	Opcional
include_extras	Incluye extras y tarifas	Boolean	Opcional

Resultado

Success

TIP

200

Resultado

Utiliza el mismo esquema que el proceso de creación del carrito de reserva

Son los mismos datos que el proceso de creación del carrito de reserva

Error

WARNING

404 Carrito de reserva no existe

POST Seleccionar vehículo

POST /api/booking-transfer/frontend/shopping-cart/{free_access_id}/set-product

Permite seleccionar el vehículo

Path Parameters

Parámetro	Descripción	Detalle
free_access_id	Identificador del carrito de la compra obtenido al iniciar el proceso de venta	String	Obligatorio

Query String

Parámetro	Descripción	Detalle
lang	Idioma	String Código ISO 639-1 (en,es,it, …)	Opcional

Request Body:

Parámetro	Descripción	Detalle
product	Código del producto	String Código	Obligatorio

{ "product": "A" }

Resultado

Success

TIP

200

Resultado

Utiliza el mismo esquema que el proceso de creación del carrito de reserva

Son los mismos datos que el proceso de creación del carrito de reserva

Error

WARNING

404 Carrito de reserva no existe

POST Añadir/modificar extra

POST /api/booking-transfer/frontend/shopping-cart/{free_access_id}/set-extra

Permite añadir un extra a la reserva o modificar la cantidad

Path Parameters

Parámetro	Descripción	Detalle
free_access_id	Identificador del carrito de la compra obtenido al iniciar el proceso de venta	String	Obligatorio

Query String

Parámetro	Descripción	Detalle
lang	Idioma	String Código ISO 639-1 (en,es,it, …)	Opcional

Request Body:

Parámetro	Descripción	Detalle
extra	Código del extra	String Código	Obligatorio
quantity	Cantidad del producto	Integer	Opcional

Resultado

Success

TIP

200

Resultado

Utiliza el mismo esquema que el proceso de creación del carrito de reserva

Son los mismos datos que el proceso de creación del carrito de reserva

Error

WARNING

404 Carrito de reserva no existe

POST Eliminar extra

POST /api/booking-transfer/frontend/shopping-cart/{free_access_id}/remove-extra

Permite eliminar un extra

Path Parameters

Parámetro	Descripción	Detalle
free_access_id	Identificador del carrito de la compra obtenido al iniciar el proceso de venta	String	Obligatorio

Query String

Parámetro	Descripción	Detalle
lang	Idioma	String Código ISO 639-1 (en,es,it, …)	Opcional

Request Body:

Parámetro	Descripción	Detalle
extra	Código del extra	String	Obligatorio

Resultado

Success

TIP

200

Resultado

Utiliza el mismo esquema que el proceso de creación del carrito de reserva

Son los mismos datos que el proceso de creación del carrito de reserva

Error

WARNING

404 Carrito de reserva no existe

POST Checkout carrito reserva

POST /api/booking-transfer/frontend/shopping-cart/{free_access_id}/checkout

Permite crear la reserva a partir del carrito de la reserva

Path Parameters

Parámetro	Descripción	Detalle
free_access_id	Identificador del carrito de la compra obtenido al iniciar el proceso de venta	String	Obligatorio

Query String

Parámetro	Descripción	Detalle
lang	Idioma	String Código ISO 639-1 (en,es,it, …)	Opcional

Request Body:

Parámetro	Descripción	Detalle
customer_name	Nombre del cliente	String(40)	Obligatorio
customer_surname	Apellidos del cliente	String(40)	Obligatorio
customer_email	Email del cliente	String(40)	Obligatorio
customer_phone	Teléfono alternativo del cliente	String(15)	Opcional
comments	Comentarios	String	Opcional
address_1	Dirección línea 1	String(256)	Opcional
address_2	Dirección línea 2	String(256)	Opcional
city	Dirección ciudad	String(256)	Opcional
state	Dirección provincia o estado	String(256)	Opcional
country	Dirección país	String(256)	Opcional
zip	Dirección código postal	String(256)	Opcional
fligth_airport_origin	Aeropuerto origen	String(100)	Opcional
flight_company	Compañía aérea	String(80)	Opcional
flight_number	Número de vuelo	String(10)	Opcional
flight_time	Hora prevista de llegada	String(5)	Opcional
fligth_airport_destination	Aeropuerto destino	String(100)	Opcional
flight_company_departure	Compañía aérea regreso	String(80)	Opcional
flight_number_departure	Número de vuelo regreso	String(10)	Opcional
flight_time_departure	Hora prevista de regreso	String(5)	Opcional

{
  "customer_name": "Toni",
  "customer_surname": "Pons",
  "customer_email": "info@mybooking.es",
  "customer_phone_number": "935551010"
}

Resultado

Success

TIP

200

Resultado

Object	Descripción
booking		object[object]
	free_access_id	String	Identificador reserva
	pay_now	Boolean	Pagar ahora
	payment	String	Cantidad a pagar “total” o “deposit”
	payment_method_id	String	Forma de pago
	total_cost	String	Coste total
	customer_email	String	Correo electrónico del cliente
	customer_name	String	Nombre del cliente
	customer_surname	String	Apellidos del cliente

{
  "free_access_id": "123456790SXDDFGREEW",
  "pay_now": true,
  "payment": "deposit",
  "payment_method_id": "redsys256",
  "total_cost": "90.00",
  "customer_email": "info@mydomain.com",
  "customer_name": "Foo",
  "customer_surname": "Bar"
}

En el caso que la operación se lleve a cabo correctamente se puede hacer un POST a /transfer/pagar

Error

WARNING

404 Carrito de reserva no existe

Consultar reserva

GET reserva

POST /api/booking-transfer/frontend/reservation/{free_access_id}

Consulta los datos de una reserva

Resultado

Success

TIP

200

booking		object[object]	Reserva
	free_access_id	String	Identificador del carrito para múltiples peticiones
	id	Number	Localizador de la reserva
	date	String YYYY-MM-DD	Fecha
	time	String HH:MM	Hora
	origin_point_id	Number	Identificador del punto de origen
	origin_point_name	String	Nombre del punto de origen
	origin_point_name_customer_translation	String	Nombre del punto de origen
	destination_point_id	Number	Identificador del punto de origen
	destination_point_name_customer_translation	String	Nombre del punto de origen
	round_trip	Boolean	Sólo ida (false) Ida y vuelta (true)
	return_date	String YYYY-MM-DD	Fecha de la vuelta
	return_time	String HH:MM	Hora de la vuelta
	return_origin_point_id	Number	Identificador del punto de origen (vuelta)
	return_origin_point_name_customer_translation	String	Nombre del punto de origen (vuelta)
	return_destination_point_id	Number	Identificador del punto de origen (vuelta)
	return_destination_point_name_customer_translation	String	Nombre del punto de origen (vuelta)
	customer_name	String	Nombre del cliente
	customer_surname	String	Apellidos del cliente
	customer_email	String	Correo electrónico del cliente
	customer_phone	String	Teléfono del cliente
	address_1	String	Dirección del cliente
	address_2	String	Dirección del cliente
	city	String	Ciudad del cliente
	state	String	Estado o provincia del cliente
	country	String	País del cliente
	zip	String	Código postal del cliente
	fligth_airport_origin	String	Aeropuerto origen
	flight_company	String	Compañía vuelo
	flight_number	String	Número de vuelo
	flight_time	String	Hora de llegada
	fligth_airport_destination	String	Aeropuerto destino
	flight_company_departure	String	Compañía vuelo regreso
	flight_number_departure	String	Número de vuelo regreso
	flight_time_departure	String	Hora del vuelo de regreso
	item_id	Number	Identificador del vehículo
	item_name	String	Nombre del vehículo
	item_name_customer_translation	String	Nombre del vehículo (traducción idioma cliente)
	item_photo	String	Path con la foto del vehículo (tamaño medio)
	item_full_photo	String	Path con la foto del vehículo (tamaño completo)
	number_of_adults	Integer	Número de adultos
	number_of_children	Integer	Número de niños
	number_of_infants	Integer	Nombre de bebés
	item_cost	String (amount)	Importe del vehículo
	extras_cost	String (amount)	Importe de los extras
	total_cost	String (amount)	Importe total
	extras	array[object]	Extras
	- extra_id	Integer	Identificador del extra
	- extra_name	String	Nombre del extra
	- extra_name_customer_translation	String	Nombre del extra (traducción idioma cliente)
	- extra_photo	String	URL foto extra
	- extra_photo_full	String	URL foto extra (tamaño completo)
	- quantity	Integer	Número de unidades

{  
    "free_access_id": "WSYVCn3GBAsEJAv3q",
    "lang": "es",
    "date": "2021/07/01",
    "time": "10:00",
    "origin_point_id": 1,
    "origin_point_name": "Aeropuerto Barajas T4",
    "origin_point_name_customer_translation": "Aeropuerto Barajas T4",
    "destination_point_id": 2,
    "destination_point_name": "Puy du fou",
    "destination_point_name_customer_translation": "Puy du fou",
    "round_trip": true,
    "return_date": "2021/07/01",
    "return_time": "10:00",
    "return_origin_point_id": 1,
    "return_origin_point_name": "Aeropuerto Barajas T4",
    "return_origin_point_name_customer_translation": "Aeropuerto Barajas T4",
    "return_destination_point_id": 2,
    "return_destination_point_name": "Puy du fou",
    "return_destination_point_name_customer_translation": "Puy du fou",
    "customer_name": "John",
    "customer_surname": "Doe",
    "customer_email": "info@mydomain.com",
    "customer_phone": "666666666",
    "address_1": "Down Street, 20",
    "address_2": "",
    "city": "London",
    "state": "London",
    "country": "United Kingdom",
    "zip": "930392039",
    "fligth_airport_origin": "",
    "flight_company": "",
    "flight_number": "",
    "flight_time": "",
    "fligth_airport_destination": "",
    "flight_company_return": "",
    "flight_number_return": "",
    "flight_time_return": "",    
    "item_id": 1,
    "item_name": "Traslado VIP 2/4 plazas",
    "item_name_customer_translation": "Traslado VIP 2/4 plazas",
    "item_photo": null,
    "item_photo_full": null,
    "number_of_adults": 3,
    "number_of_children": 0,
    "number_of_infants": 0,
    "item_cost": "121.00",
    "extras_cost": "0.00",
    "total_cost": "121.00",
    "extras": [
      {"extra_id": 1,
       "extra_name": "Servicio maletas",
       "extra_name_customer_translation": "Servicio maletas",
       "extra_photo": null,
       "extra_photo_full": null,
       "quantity": 1,
       "extra_unit_cost": "5.00",
       "extra_cost": "5.00" }
    ]                
}