Overview

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

📘
Note: Partners can only cancel reservations that are scoped to their credntials.

Endpoints Available

Method	Endpoint	Description
DELETE	v2024.07.31/reservations/{reservation_id}	Use this endpoint to cancel a reservation

Path Parameters

Path Parameter	Required / Optional	Description
{reservation_id}	Required	The unique identifier for the reservation to cancel

Response Definition

Response Item	Description	Data Type
`"id"`	The unique identifier for the canceled reservation.	int
`"unit_id"`	The unique identifier for the unit associated with the canceled reservation.	int
`"type"`	Indicates the status type of the reservation, which is "cancelled" in this case	string

Sample Request

curl --location --request DELETE 'https://api.ciiruspartners.com/v2024.07.31/reservations/41497629' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

Sample Response

{
    "id": 41497629,
    "unit_id": 219264,
    "reference": "",
    "type": "cancelled",
    "management_company_user_id": 42330,
    "details": {
        "arrival": "2026-10-17T16:00:00",
        "departure": "2026-10-20T10:00:00",
        "added": "2025-02-03T13:53:15.007",
        "cancelled_on": "2025-04-29T21:20:53.727",
        "scenario": 0,
        "comments": [
            {
                "text": "",
                "type": "general"
            }
        ],
        "guests": [
            {
                "id": 7813822,
                "type": "lead_guest",
                "first_name": "CiiRUSSupport",
                "last_name": "TestBooking",
                "phone_numbers": [
                    "3212518020"
                ],
                "email_addresses": [
                    "[email protected]"
                ],
                "customer_address": {}
            },
            {
                "first_name": "Guest",
                "last_name": "B",
                "age": 30
            }
        ],
        "number_of_adults": 0,
        "number_of_children": 0,
        "category": "TOR",
        "category_id": 16,
        "category_description": "Tour Operator Reservation",
        "secure_details": {
            "lock_box_code": "",
            "gate_code": "0856",
            "alarm_code": "2150",
            "wifi_ssid": "MyNetwork",
            "wifi_password": "MyNetworkPW123",
            "lobby_code": "",
            "fitness_room_code": "",
            "pool_access_code": "",
            "beach_access_code": ""
        },
        "early_check_in": false,
        "late_check_out": false,
        "arrival_departure_info": "",
        "owner_reservation": false,
        "unit_name": "Test Property 1"
    },
    "financials": {
        "currency": "USD",
        "merchant_of_record": "management_company",
        "merchant_of_record_user": 0,
        "charges": [
            {
                "item": "Rental Rate",
                "code": "Rent",
                "applies_to_id": "Rent",
                "quantity": 1,
                "type": "rental",
                "value": 16500000000
            },
            {
                "item": "Clean Fee",
                "code": "Clean",
                "applies_to_id": "Clean",
                "quantity": 1,
                "type": "clean_fee",
                "value": 20000000000
            },
            {
                "item": "Clean Fee Tax 1",
                "code": "Clean",
                "applies_to_id": "Clean",
                "quantity": 1,
                "type": "tax_one",
                "value": 1500000000
            },
            {
                "item": "Clean Fee Tax 2",
                "code": "Clean",
                "applies_to_id": "Clean",
                "quantity": 1,
                "type": "tax_two",
                "value": 1200000000
            },
            {
                "item": "Booking Fee",
                "code": "BookingFee",
                "applies_to_id": "Booking-Fee",
                "quantity": 1,
                "type": "booking_fee",
                "value": 300000000
            },
            {
                "item": "Booking Fee Tax 1",
                "code": "BookingFee",
                "applies_to_id": "Booking-Fee",
                "quantity": 1,
                "type": "tax_one",
                "value": 23000000
            },
            {
                "item": "Booking Fee Tax 2",
                "code": "BookingFee",
                "applies_to_id": "Booking-Fee",
                "quantity": 1,
                "type": "tax_two",
                "value": 18000000
            },
            {
                "id": 7417,
                "item": "Fee1",
                "code": "Fee1",
                "applies_to_id": "7417",
                "quantity": 1,
                "type": "extra",
                "value": 495000000
            },
            {
                "item": "Fee1 Tax 1",
                "code": "Fee1",
                "applies_to_id": "7417",
                "quantity": 1,
                "type": "tax_one",
                "value": 37
            },
            {
                "item": "Fee1 Tax 2",
                "code": "Fee1",
                "applies_to_id": "7417",
                "quantity": 1,
                "type": "tax_two",
                "value": 29
            },
            {
                "id": 7421,
                "item": "Fee5",
                "code": "Fee5",
                "applies_to_id": "7421",
                "quantity": 1,
                "type": "extra",
                "value": 1500000000
            },
            {
                "id": 25011,
                "item": "CP-STD",
                "code": "CP-STD",
                "applies_to_id": "25011",
                "quantity": 1,
                "type": "extra",
                "value": 6500000000
            },
            {
                "id": 21728,
                "item": "ADI",
                "code": "ADI",
                "applies_to_id": "21728",
                "quantity": 1,
                "type": "extra",
                "value": 7500000000
            }
        ],
        "payments": [],
        "payment_schedule": [
            {
                "value": 100000000,
                "value_due": 100000000,
                "payment_type": "down_payment",
                "payment_status": "scheduled",
                "due_date": "2025-02-03T13:53:15.007"
            },
            {
                "value": 55503000000,
                "value_due": 55503000000,
                "payment_type": "scheduled_payment",
                "payment_status": "due",
                "due_date": "2026-08-22T00:00:00"
            }
        ],
        "total_paid": 0,
        "total_value": 55603000000
    },
    "last_modified": "2025-04-29T17:20:54.417"
}