Overview

The Retrieve Reservations request provides the Agent with a method to access reservation data in the system. By making this API call, the API User can efficiently retrieve and integrate reservation information.

Whether the objective is to retrieve all reservations available to the API user or obtain information about a specific reservation using its unique identifier, this request provides essential reservation details such as reservation dates, guest information, pricing, and more.

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/reservations	Retrieves all the reservations available to the API user
GET	v2023.07.31/reservations/`{reservationId}`	Retrieves a specific reservation

Path Parameters

Path Parameter	Required / Optional	Description
`{reservationId}`	Required	Unique Identifier for a reservation

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown	int
pageSize	Optional	Limits the number of returned results	int
lastUpdateDate	Optional	Only return objects which have been modified after a certain date	date-time
mcUserId	Optional	Unique Identifier for Supplier	int
mcUserIds	Optional	Unique Identifier for Suppliers	array
reference	Optional	Unique Identifier for a reservation	string
references	Optional	Unique Identifier for reservations	arrays
unitId	Optional	Unique Identifier for Unit in Inventory	int
unitIds	Optional	Unique Identifier for Units in Inventory	array
modifiedStart	Optional	Only return reservations that have been modified after a certain date	date-time
modifiedEnd	Optional	Only return reservations that have been modified before a certain date	date-time
arrivalStart	Optional	Only return reservations that arrive after a certain date	date-time
arrivalEnd	Optional	Only return reservations that arrive before a certain date	date-time
departureStart	Optional	Only return reservations that depart after a certain date	date-time
departureEnd	Optional	Only return reservations that depart before a certain date	date-time
cancelledStart	Optional	Only return reservations that have been canceled after a certain date	date-time
cancelledEnd	Optional	Only return reservations that have been canceled before a certain date	date-time
addedStart	Optional	Only return reservations that have been added after a certain date	date-time
addedEnd	Optional	Only return reservations that have been added before a certain date	date-time
cancelled	Optional	Only return reservations that have been canceled	date-time
quote	Optional	Only return reservations that are quotes	boolean
tentative	Optional	Only return reservations that are tentative	boolean
lynnbrook	Optional	Only return specific properties for Lynnbrook	boolean
categoryIds	Optional	Accepts an array of booking categories and verifies if they match either the BookingCategory or CSBookingCategory columns	array

Response Definition

Response Item	Description	Data Type
`"reservations"`	An array containing details about the associated reservation	array

`"reservations"` Object

Response Item	Description	Data Type
`"id"`	Unique identifier for the reservation	int
`"arrival"`	Date and time of the guest's arrival	string
`"departure"`	Date and time of the guest's departure	string
`"added"`	Timestamp when the reservation was added	string
`"reference"`	Additional Agent reference or identifier for the reservation	string
`"last_modified"`	Timestamp when the reservation was last modified	string
`"status"`	Status of the reservation (e.g., CONFIRMED)	string
`"unit_id"`	Unique identifier for the unit associated with the reservation	int
`"owner_reservation"`	A flag indicating whether the reservation is an owner's reservation (true) or not (false)	boolean
`"payments"`	An array containing information about payments made for the reservation. Each element of the array represents a payment with specific details	array
`"payment_schedule"`	An array containing payment schedule details	array
`"comments"`	Additional comments or notes added to the reservation	string
`"total"`	The total amount for the reservation	long
`"total_paid"`	The total amount paid for the reservation	long
`"amount_decimal_places"`	Number of decimal places for `"total"` and `"total_paid"`	int
`"currency"`	Currency used for the reservation	string
`"financials"`	An object containing financial details related to the reservation	object
`"merchant_of_record"`	Specifies who is the merchant of record for the reservation. Possible values include "AGENT," or "SUPPLIER"	string
`"commission_amount"`	The commission amount associated with the reservation	long
`"total_amount"`	The total amount of the reservation	long
`"amount_decimal_places"`	The number of decimal places for the `"commission_amount"` and `"total_amount"`	int
`"secure_details"`	An object that contains various secure details related to the reservation	object
`"category"`	Category of the reservation	string
`"category_id"`	Unique identifier for the reservation category	int
`"scenario"`	Scenario identifier for the reservation	int
`"adults"`	Number of adults in the reservation	int
`"children"`	Number of children in the reservation	int
`"lead_guest_details"`	An object containing details about the lead guest (main guest) for the reservation	object
`"guest_list"`	An array containing details about additional guests in the reservation. Each element of the array represents a guest	array
`"early_check_in"`	Indicates whether early check-in is allowed for the reservation (true/false)	boolean
`"early_check_out"`	Indicates whether late check-out is allowed for the reservation (true/false)	boolean
`"mc_user_id"`	Unique identifier of the Supplier associated with the reservation	int

`"payments"` Object

Response Item	Description	Data Type
`"payment_id"`	The unique identifier for the payment	int
`"amount"`	The amount of the payment	int
`"amount_decimal_places"`	The number of decimal places used in the `"amount"` value	int
`"payment_date"`	The date and time when the payment was made	string
`"payment_method"`	The method used for making the payment (e.g., Card, Check, Wire Transfer)	string
`"payment_type"`	The type of payment (e.g., Payment, Refund, Deposit)	string
`"description"`	A description or additional information about the payment	string

`"payment_schedule"` Object

Response Item	Description	Data Type
`"amount_due"`	The amount that is due for the reservation	long
`"amount_decimal_places"`	The number of decimal places for the `"amount_due"`	int
`"due_date"`	The date and time when the `"amount_due"` is due for the reservation	string

`"financials"` Object


`"charges"`	An array containing different charges related to the reservation	array

`"charges"` Object

Response Item	Description	Data Type
`"item"`	The name of the charge item	string
`"id"`	The unique identifier for the charge item	string
`"code"`	The code associated with the charge item	string
`"applies_to_id"`	The identifier specifying the charge item it applies to	string
`"quanity"`	The quantity of the charge item	int
`"type"`	The type of the charge item which can be "RENTAL" for rental rate, "CLEAN_FEE" for cleaning fee, "TAX_ONE" for tax one, "TAX_TWO" for tax two, or "EXTRA" for additional fees	string
`"amount"`	The amount of the charge item	long
`"amount_decimal_places"`	The number of decimal places for the `"amount"`	int

`"secure_details"` Object

Response Item	Description	Data Type
`"lock_box_code"`*	The lock box code for accessing the property (if applicable)	string
`"gate_code"`*	The gate code for accessing the property (if applicable)	string
`"alarm_code"`*	The alarm code for the property's security system (if applicable)	string
`"wifi_ssid"`*	The Wi-Fi SSID for accessing the property's internet (if applicable)	string
`"wifi_password"`*	The Wi-Fi password for accessing the property's internet (if applicable)	string
`"lobby_code"`*	The lobby access code for the property (if applicable)	string
`"fitness_room_code"`*	The access code for the fitness room (if applicable)	string
`"pool_access_code"`*	The access code for the pool area (if applicable)	string
`"beach_access_code"`*	The access code for the beach area (if applicable)	string

`"lead_guest_details"` Object

Response Item	Description	Data Type
`"name"`	The full name of the lead guest	string
`"first_name"`	The first name of the lead guest	string
`"last_name"`	The last name of the lead guest	string
`"phone"`	The phone number of the lead guest	string
`"email"`	The email address of the lead guest	string
`"address"`	The address details of the lead guest	object

`"address"` Object

Response Item	Description	Data Type
`"address_line_1"`	The first line of the address	string
`"address_line_2"`	The second line of the address (if applicable)	string
`"city"`	The city name in the address	string
`"state_province"`	The state or province in the address	string
`"country"`	The country in the address	string
`"postal_code"`	The postal or ZIP code in the address	string

`"guest_list"` Object

Response Item	Description	Data Type
`"name"`	The name of the guest	string
`"age"`	The age of the guest	int

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/reservations?page=1&pageSize=50&arrivalStart=2023-07-25'

Sample Response

{
    "reservations": [
        {
            "id": 38129530,
            "arrival": "2023-08-20T19:00:00",
            "departure": "2023-08-23T10:30:00",
            "added": "2023-07-25T11:16:12.72",
            "reference": "",
            "last_modified": "2023-07-25T11:25:41.507",
            "status": "CONFIRMED",
            "unit_id": 219264,
            "owner_reservation": false,
            "payments": [
              {
                    "payment_id": 2651445,
                    "amount": 15000,
                    "amount_decimal_places": 2,
                    "payment_date": "2023-07-26T00:00:00",
                    "payment_method": "Card",
                    "payment_type": "Payment",
                    "description": "Rental payment"
                }
            ],
            "payment_schedule": [
                {
                    "amount_due": 107825,
                    "amount_decimal_places": 2,
                    "due_date": "2023-09-25T11:16:12.72"
                }
            ],
            "comments": "",
            "total": 10675,
            "total_paid": 0,
            "amount_decimal_places": 2,
            "currency": "US Dollars",
            "financials": {
                "charges": [
                    {
                        "item": "Rental Rate",
                        "id": "Rent",
                        "code": "Rent",
                        "applies_to_id": "Rent",
                        "quantity": 1,
                        "type": "RENTAL",
                        "amount": 90000,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "Rental Rate Tax 1",
                        "id": "Rent-Tax-1",
                        "code": "Rent",
                        "applies_to_id": "Rent",
                        "quantity": 1,
                        "type": "TAX_ONE",
                        "amount": 6750,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "Rental Rate Tax 2",
                        "id": "Rent-Tax-2",
                        "code": "Rent",
                        "applies_to_id": "Rent",
                        "quantity": 1,
                        "type": "TAX_TWO",
                        "amount": 5400,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "Clean Fee",
                        "id": "Clean",
                        "code": "Clean",
                        "applies_to_id": "Clean",
                        "quantity": 1,
                        "type": "CLEAN_FEE",
                        "amount": 5000,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "Clean Fee Tax 1",
                        "id": "Clean-Tax-1",
                        "code": "Clean",
                        "applies_to_id": "Clean",
                        "quantity": 1,
                        "type": "TAX_ONE",
                        "amount": 375,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "Clean Fee Tax 2",
                        "id": "Clean-Tax-2",
                        "code": "Clean",
                        "applies_to_id": "Clean",
                        "quantity": 1,
                        "type": "TAX_TWO",
                        "amount": 300,
                        "amount_decimal_places": 2
                    },
                    {
                        "item": "ETS",
                        "id": "17626",
                        "code": "ETS",
                        "applies_to_id": "17626",
                        "quantity": 1,
                        "type": "EXTRA",
                        "amount": 5000,
                        "amount_decimal_places": 2
                    }
                ],
                "merchant_of_record": "AGENT",
                "commission_amount": 87000,
                "total_amount": 10675,
                "amount_decimal_places": 2
            },
            "secure_details": {
                "lock_box_code": "",
                "gate_code": "",
                "alarm_code": "",
                "wifi_ssid": "",
                "wifi_password": "",
                "lobby_code": "",
                "fitness_room_code": "",
                "pool_access_code": "",
                "beach_access_code": ""
            },
            "category": "CLNTRO",
            "category_id": 7838,
            "scenario": 8,
            "adults": 1,
            "children": 0,
            "lead_guest_details": {
                "name": "CiiRUS Test",
                "first_name": "CiiRUS",
                "last_name": "Test",
                "phone": "3212518020",
                "email": "[email protected]",
                "address": {
                    "address_line_1": "1142 Celebration Blvd",
                    "address_line_2": "",
                    "city": "Celebration",
                    "state_province": "FL",
                    "country": "US",
                    "postal_code": "34747"
                }
            },
            "guest_list": [
               {
                    "name": "Guest0",
                    "age": 21
                }
            ],
            "early_check_in": false,
            "late_check_out": false,
            "mc_user_id": 42330
        },
      ...
     ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/reservations?page=2&pageSize=50",
    "total_page_count": 125
}

Overview

Endpoints Available

Path Parameters

Query String Parameters

Response Definition

"reservations" Object

"payments" Object

"payment_schedule" Object

"financials" Object

"charges" Object

"secure_details" Object

"lead_guest_details" Object

"address" Object

"guest_list" Object