Cancelar una Reserva

La cancelación de una reserva es necesaria cuando se determina que una reserva no se convertirá en una transacción. Esta acción libera los productos reservados y puede ser útil para optimizar la gestión de disponibilidad en la plataforma.

1. Método de Acceso

Parámetro

Descripción

URL

{baseurl}/api/reservation

URL (Versión 3.60)

{baseurl}/api/reservation&api-version=3.60

Verbo HTTP

DELETE

Formato de Envío

application/json

 

2. Datos de Envío

Para cancelar una reserva, se deben enviar los siguientes parámetros:

Campo

Descripción

ApiKey

Clave privada única del colaborador. Debe mantenerse secreta.

IsTest

Si es true, no se realizará ninguna acción real en la API, solo una simulación.

ReservationId

Identificador de la reserva a cancelar.

api-version

Versión de la API a utilizar (por defecto 3.21).

 

3. Ejemplo de Petición

{

    "ApiKey": "{partnerId}",

    "IsTest": false,

    "ReservationId": "zp83haxd5ucwn"

}

Ejemplo de Cancelación en cURL

curl -X DELETE "{baseurl}/api/reservation" \

     -H "Content-Type: application/json" \

     -d '{

           "ApiKey": "{partnerId}",

           "IsTest": false,

           "ReservationId": "zp83haxd5ucwn"

         }'

4. Estructura de la Respuesta

Si la cancelación es exitosa, la API devuelve la siguiente estructura:

Campo

Descripción

Success

true si la reserva se canceló correctamente.

Timestamp

Hora en la que se procesó la cancelación.

ErrorMessage

Mensaje de error en caso de falla.

ErrorCodes

Códigos de error asociados al fallo, si aplica.

ErrorEntityBreakDown

Lista de objetos con identificadores de los errores.

 

5. Ejemplo de Respuesta Exitosa

{

    "Success": true,

    "ErrorMessage": "",

    "Timestamp": "2025-02-05T14:46:39.532802",

    "ErrorEntityBreakDown": []

}

6. Ejemplo de Respuesta con Error

{

    "Success": false,

    "ErrorMessage": "La reserva no existe o ya fue cancelada.",

    "Timestamp": "2025-02-05T14:50:22.123456",

    "ErrorEntityBreakDown": [

        {

            "Id": "zp83haxd5ucwn",

            "Name": "Reserva no encontrada"

        }

    ]

}

7. Consideraciones Finales

  • La reserva debe existir y estar activa para poder ser cancelada.
  • Si la reserva ya expiró, la API puede devolver un error indicando que no se encontró.
  • No se pueden cancelar reservas que ya han sido convertidas en transacciones.
  • Si la reserva contiene productos con reglas de cancelación, estas se aplicarán según la política definida en la reserva.
  • La cancelación libera los productos reservados, permitiendo que vuelvan a estar disponibles para otros usuarios.

¿Te ha parecido útil este artículo?