Overview

The Cancel Booking function enables you to cancel existing bookings via the Partner-API. This guide provides parameter details for booking cancellation within your application.

Endpoints Available

Method	Endpoint	Description
DELETE	v2023.07.31/booking/{bookingId}	Use this endpoint to cancel a booking

Path Parameters

Path Parameter	Required / Optional	Description
{bookingId}	Required	The unique identifier for the booking to cancel

Response Definition

Response Item	Description	Data Type
`"booking_id"`	The unique identifier for the canceled booking	int
`"inventory_id"`	The unique identifier for the unit associated with the canceled booking	int
`"type"`	Indicates the status type of the booking, which is "CANCELLED" in this case	string
`"ip_address"`	The IP address from which the cancellation request originated	string

Sample Request

curl --request DELETE \
     --url https://api.ciiruspartners.com/v2023.07.31/booking/38418881 \
     --header 'accept: application/json'

Sample Response

{
    "booking_id": 38418881,
    "inventory_id": 219264,
    "type": "CANCELLED",
    "ip_address": "9.8.8.7"
}