Retrieve Quotes

Generate a Quote for the specified Unit and Date Range

Overview

The Retrieve Quote request provides functionality that allows the Agent to generate a detailed quote for a specific Unit and date range or multiple units and date ranges. By making this request, partners can receive comprehensive information about the pricing and availability of a property during the specified time frame.

The Retrieve Quote API offers partners the ability to accurately calculate costs for potential reservations. It takes into account various factors, such as rates, taxes, and any additional fees associated with the Booking.

Endpoints Available

Method	Endpoint	Description
POST	v2023.07.31/quote	Generate a Quote for a specific Unit and date range
POST	v2023.07.31/quotes	Generate multiple Quotes for Units and date ranges

Body Parameters

Parameter	Required / Optional	Description	Data Type
`"inventory_id"`	Required	Unique Identifier for Unit in Inventory	int
`"organization_id"`	Optional	The organization under which the booking is made/quoted	int
`"source"`	Required	The source of the Quote. It indicates the origin or provider of the Quote	string
`"source_id"`	Required	Unique identifier from the source system. It uniquely identifies the data in the source system	string
`"optional_extras"`	Optional	Total of Optional Extras to apply	array
`"pool_heat"`	Optional	Indicates if you would like pool heat auto-quoted for you	boolean
`"length_of_stay_pricing"`	Optional	Indicates if length of stay pricing is included in the quote	boolean
`"discount_code"`	Optional	Input discount code item code here to apply it to the quote	string
`"details"`	Required	An object containing various details related to the booking	object
`"thread_id"`	Optional	Unique identifier for the conversation thread. Used to associate the Quote with a specific conversation or thread.	string

`"details"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"arrival"`	Required	A value specifying the arrival date for the booking	date-time
`"departure"`	Required	A value specifying the departure date for the booking	date-time
`"origination_date"`	Required	A value representing the date-time the quote was generated	date-time
`"number_of_adults"`	Required	Number of Adults	int
`"number_of_children"`	Required	Number of Children	int
`"number_of_pets"`	Required	Number of Pets	int
`"party_members"`		An array containing details about additional Party Members	array

`"party_members"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"first_name"`		First name of a party member	string
`"last_name"`		Last name of a party member	string
`"age"`		Age of a party member	int

Response Definition

Response Item	Description	Data Type
`"financials"`	An object containing financial details related to the booking	object
`"payment_schedule"`	An array containing details about the payment schedule for the booking	array
`"inventory_id"`	The unique identifier for the Unit associated with the booking	int
`"organization_id"`	The unique identifier for the Supplier associated with the booking	int
`"details"`	An object containing specific details related to the booking	object

`"financials"` Object

Response Item	Description	Data Type
`"charges"`	An array containing details about individual charges associated with the booking. Each element in the array represents a specific charge item, such as Rental Rate, Clean Fee, Taxes, or Extra Fees	array
`"total_amount"`	The total amount of the booking, including all charges	long
`"amount_decimal_places"`	The number of decimal places in the `"total_amount"` value	int

`"charges"` Object

Response Item	Description	Data Type
`"item"`	The name or description of the charge item	string
`"id"`	The unique identifier for the charge item	string
`"code"`	A code representing the charge item	string
`"applies_to_id"`	The identifier indicating which item the charge applies to	string
`"quantity"`	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 charges item	long
`"amount_decimal_places"`	The number of decimal places in the `"amount"` value	int

`"payment_schedule"` Object

Response Item	Description	Data Type
`"amount_due"`	The amount due for the payment schedule	long
`"rate_decimal_places"`	The number of decimal places in the `"amount_due"` value	int
`"due_date"`	The due date for the payment schedule - ISO 8601 date-time format	string

`"details"` Object

Response Item	Description	Data Type
`"arrival"`	The arrival date for the booking	string
`"departure"`	The departure date for the booking	string
`"number_of_adults"`	The number of adults included in the booking	int
`"number_of_children"`	The number of children included in the booking	int
`"number_of_pets"`	The number of pets included in the booking	int
`"origination_date"`	The origination date of the booking	string

Sample Request

curl --request POST \
     --url 'https://api.ciiruspartners.com/v2023.07.31/quote'
          --data '
{
  "source": "SupportTest",
  "source_id": "Test123456",
  "details": {
    "number_of_adults": 1,
    "number_of_children": 0,
    "number_of_pets": 0,
    "arrival": "2023-09-15",
    "departure": "2023-09-22",
    "origination_date": "2023-07-24"
  },
  "pool_heat": false,
  "length_of_stay_pricing": false,
  "inventory_id": 219264
}
'

Sample Response

{
    "financials": {
        "charges": [
            {
                "item": "Rental Rate",
                "id": "Rent",
                "code": "Rent",
                "applies_to_id": "Rent",
                "quantity": 1,
                "type": "RENTAL",
                "amount": 70000,
                "amount_decimal_places": 2
            },
            {
                "item": "Clean Fee",
                "id": "Clean",
                "code": "Clean",
                "applies_to_id": "Clean",
                "quantity": 1,
                "type": "CLEAN_FEE",
                "amount": 20000,
                "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": 1500,
                "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": 1200,
                "amount_decimal_places": 2
            },
            {
                "item": "Fee Exqmple 6 Tax 1",
                "id": "Fee Exqmple 6-Tax-1",
                "code": "Fee6",
                "applies_to_id": "7422",
                "quantity": 1,
                "type": "TAX_ONE",
                "amount": 37,
                "amount_decimal_places": 2
            },
            {
                "item": "Fee Exqmple 6 Tax 2",
                "id": "Fee Exqmple 6-Tax-2",
                "code": "Fee6",
                "applies_to_id": "7422",
                "quantity": 1,
                "type": "TAX_TWO",
                "amount": 30,
                "amount_decimal_places": 2
            },
            {
                "item": "Fee Exqmple 6",
                "id": "7422",
                "code": "Fee6",
                "applies_to_id": "7422",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 500,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 2 Tax 1",
                "id": "Example Fee 2-Tax-1",
                "code": "Fee2",
                "applies_to_id": "7418",
                "quantity": 1,
                "type": "TAX_ONE",
                "amount": 525,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 2 Tax 2",
                "id": "Example Fee 2-Tax-2",
                "code": "Fee2",
                "applies_to_id": "7418",
                "quantity": 1,
                "type": "TAX_TWO",
                "amount": 420,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 2",
                "id": "7418",
                "code": "Fee2",
                "applies_to_id": "7418",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 7000,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 3 Tax 1",
                "id": "Example Fee 3-Tax-1",
                "code": "Fee3",
                "applies_to_id": "7419",
                "quantity": 1,
                "type": "TAX_ONE",
                "amount": 75,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 3 Tax 2",
                "id": "Example Fee 3-Tax-2",
                "code": "Fee3",
                "applies_to_id": "7419",
                "quantity": 1,
                "type": "TAX_TWO",
                "amount": 60,
                "amount_decimal_places": 2
            },
            {
                "item": "Example Fee 3",
                "id": "7419",
                "code": "Fee3",
                "applies_to_id": "7419",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 1000,
                "amount_decimal_places": 2
            },
            {
                "item": "Accidental Damage Insurance",
                "id": "21728",
                "code": "ADI",
                "applies_to_id": "21728",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 7500,
                "amount_decimal_places": 2
            },
            {
                "item": "Daily Amount Fee Example",
                "id": "24651",
                "code": "DAY",
                "applies_to_id": "24651",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 12250,
                "amount_decimal_places": 2
            },
            {
                "item": "Property Protection Fee",
                "id": "25011",
                "code": "CP-STD",
                "applies_to_id": "25011",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 6500,
                "amount_decimal_places": 2
            },
            {
                "item": "Booking Fee",
                "id": "Booking",
                "code": "Booking",
                "applies_to_id": "Booking",
                "quantity": 1,
                "type": "EXTRA",
                "amount": 300,
                "amount_decimal_places": 2
            },
            {
                "item": "Booking Fee Tax 1",
                "id": "Booking-Tax-1",
                "code": "Booking",
                "applies_to_id": "Booking",
                "quantity": 1,
                "type": "TAX_ONE",
                "amount": 23,
                "amount_decimal_places": 2
            },
            {
                "item": "Booking Fee Tax 2",
                "id": "Booking-Tax-2",
                "code": "Booking",
                "applies_to_id": "Booking",
                "quantity": 1,
                "type": "TAX_TWO",
                "amount": 18,
                "amount_decimal_places": 2
            }
        ],
        "total_amount": 128938,
        "amount_decimal_places": 2
    },
    "payment_schedule": [
        {
            "amount_due": 128938,
            "rate_decimal_places": 2,
            "due_date": "2023-07-26T00:00:00Z"
        }
    ],
    "inventory_id": 219264,
    "organization_id": 42330,
    "details": {
        "arrival": "2023-09-15T00:00:00",
        "departure": "2023-09-22T00:00:00",
        "number_of_adults": 1,
        "number_of_children": 0,
        "number_of_pets": 0,
        "origination_date": "2023-07-26T00:00:00"
    }
}

Updated 3 months ago