Quotes

The final price and availability check for a list of rates.

Schema

accommodation
object

The accommodation associated with this quote

base_amount
stringnullable

The base amount for this quote, excluding taxes and fees. Will be null if the base amount is unknown. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "665.83"
base_currency
string

The currency of the base_amount, as an ISO 4217 currency code. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "GBP"
check_in_date
date

The ISO 8601 date on which the guest wants to check in. This comes from the search request this quote originates from.

Example: "2023-05-24"
check_out_date
date

The ISO 8601 date on which the guest wants to check out. This comes from the search request this quote originates from.

Example: "2023-05-28"
due_at_accommodation_amount
stringnullable

Mandatory fees or taxes that are due by the guest at the accommodation. Will be null if the amount due at accommodation is unknown. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "39.95"
due_at_accommodation_currency
string

The currency of the due_at_accommodation_amount, as an ISO 4217 currency code. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "GBP"
fee_amount
stringnullable

The fee amount for this quote. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "50.94"
fee_currency
string

The currency of the fee_amount, as an ISO 4217 currency code. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "GBP"
guests
listnullable

The list of guests travelling for this quote.

id
string

The id of the stay quote

Example: "quo_0000AS0NZdKjjnnHZmSUbI"
rooms
integer

The number of rooms this quote is for

Example: 1
supported_loyalty_programme
enumnullable

The loyalty programme that this quote supports.

Possible values: "wyndham_rewards", "choice_privileges", "marriott_bonvoy", "best_western_rewards", "world_of_hyatt", "hilton_honors", "ihg_one_rewards", "leaders_club", "stash_rewards", "omni_select_guest", "i_prefer", "accor_live_limitless", "my_6", "jumeirah_one", "global_hotel_alliance_discovery", or "duffel_hotel_group_rewards"
tax_amount
stringnullable

The tax amount for this quote. Will be null if the tax amount is unknown. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "82.23"
tax_currency
string

The currency of the tax_amount, as an ISO 4217 currency code. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "GBP"
total_amount
string

The total price for the room for all nights and for all guests. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "799.00"
total_currency
string

The currency of the total_amount, as an ISO 4217 currency code. This is the same as the equivalent property of the Rate associated with this Quote. See Rate documentation for more details.

Example: "GBP"

Get quote

Gets a specific quote made by your organisation.

URL parameters

id
stringrequired

The id of the stay quote

Example: "quo_0000AS0NZdKjjnnHZmSUbI"

Endpoint

GET https://api.duffel.com/stays/quotes/{id}

Request

curl -X GET --compressed "https://api.duffel.com/stays/quotes/{id}" \
  -H "Accept-Encoding: gzip" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Duffel-Version: v2" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

Response

{
  "data": {
    "total_currency": "GBP",
    "total_amount": "799.00",
    "tax_currency": "GBP",
    "tax_amount": "82.23",
    "supported_loyalty_programme": "duffel_hotel_group_rewards",
    "rooms": 1,
    "id": "quo_0000AS0NZdKjjnnHZmSUbI",
    "fee_currency": "GBP",
    "fee_amount": "50.94",
    "due_at_accommodation_currency": "GBP",
    "due_at_accommodation_amount": "39.95",
    "check_out_date": "2023-05-28",
    "check_in_date": "2023-05-24",
    "base_currency": "GBP",
    "base_amount": "665.83",
    "accommodation": {
      "supported_loyalty_programme": "duffel_hotel_group_rewards",
      "rooms": [
        {
          "rates": [
            {
              "total_currency": "GBP",
              "total_amount": "799.00",
              "tax_currency": "GBP",
              "tax_amount": "82.23",
              "supported_loyalty_programme": "duffel_hotel_group_rewards",
              "quantity_available": 12,
              "public_currency": "GBP",
              "public_amount": "699.99",
              "payment_type": "pay_now",
              "id": "rat_0000BTVRuKZTavzrZDJ4cb",
              "fee_currency": "GBP",
              "fee_amount": "50.94",
              "due_at_accommodation_currency": "GBP",
              "due_at_accommodation_amount": "39.95",
              "deal_types": [
                "closed_user_group",
                "mobile"
              ],
              "conditions": [
                {
                  "title": "Parking",
                  "description": "Public parking is available nearby for £15 per day"
                }
              ],
              "cancellation_timeline": [
                {
                  "refund_amount": "799.00",
                  "currency": "GBP",
                  "before": "2023-05-23T13:00:00Z"
                }
              ],
              "board_type": "room_only",
              "base_currency": "GBP",
              "base_amount": "665.83",
              "available_payment_methods": [
                [
                  "balance",
                  "card"
                ]
              ]
            }
          ],
          "photos": [
            {
              "url": "https://assets.duffel.com/img/stays/image.jpg"
            }
          ],
          "name": "Double Suite",
          "beds": [
            {
              "type": "king",
              "count": 2
            }
          ]
        }
      ],
      "review_score": 8.8,
      "rating": 3,
      "photos": [
        {
          "url": "https://assets.duffel.com/img/stays/image.jpg"
        }
      ],
      "phone_number": "+442074938181",
      "name": "Duffel Test Hotel",
      "location": {
        "geographic_coordinates": {
          "longitude": -0.1416,
          "latitude": 51.5071
        },
        "address": {
          "region": "England",
          "postal_code": "EC2A 4TP",
          "line_one": "100 Clifton Street",
          "country_code": "GB",
          "city_name": "London"
        }
      },
      "key_collection": {
        "instructions": "Please collect the keys from accommodation's reception."
      },
      "id": "acc_0000AWr2VsUNIF1Vl91xg0",
      "email": "reservations@duffel-hotel-group.com",
      "description": "Ornate quarters, some with grand pianos, in a luxurious hotel offering acclaimed dining & a spa.",
      "check_in_information": {
        "check_out_before_time": "11:30",
        "check_in_after_time": "14:30"
      },
      "chain": {
        "name": "Duffel Hotel Group"
      },
      "brand": {
        "name": "Duffel Test",
        "id": "bra_0000Alr8BYNsbmDMThHSbI"
      },
      "amenities": [
        {
          "type": "parking",
          "description": "Parking"
        }
      ]
    }
  }
}

Create a quote for a rate

Creates a ready-to-book Duffel Stay Quote — a prospective booking — from a given room rate. This step confirms availability of the rate and total pricing of the booking.

Body parameters

rate_id
stringrequired

The id of the rate you want to book.

Example: "rat_0000ARxBI85qTkbVapZDD2"

Endpoint

POST https://api.duffel.com/stays/quotes

Request

curl -X POST --compressed "https://api.duffel.com/stays/quotes" \
  -H "Accept-Encoding: gzip" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Duffel-Version: v2" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  -d '{
  "data": {
    "rate_id": "rat_0000ARxBI85qTkbVapZDD2"
  }
}'

Response

{
  "data": {
    "total_currency": "GBP",
    "total_amount": "799.00",
    "tax_currency": "GBP",
    "tax_amount": "82.23",
    "supported_loyalty_programme": "duffel_hotel_group_rewards",
    "rooms": 1,
    "id": "quo_0000AS0NZdKjjnnHZmSUbI",
    "fee_currency": "GBP",
    "fee_amount": "50.94",
    "due_at_accommodation_currency": "GBP",
    "due_at_accommodation_amount": "39.95",
    "check_out_date": "2023-05-28",
    "check_in_date": "2023-05-24",
    "base_currency": "GBP",
    "base_amount": "665.83",
    "accommodation": {
      "supported_loyalty_programme": "duffel_hotel_group_rewards",
      "rooms": [
        {
          "rates": [
            {
              "total_currency": "GBP",
              "total_amount": "799.00",
              "tax_currency": "GBP",
              "tax_amount": "82.23",
              "supported_loyalty_programme": "duffel_hotel_group_rewards",
              "quantity_available": 12,
              "public_currency": "GBP",
              "public_amount": "699.99",
              "payment_type": "pay_now",
              "id": "rat_0000BTVRuKZTavzrZDJ4cb",
              "fee_currency": "GBP",
              "fee_amount": "50.94",
              "due_at_accommodation_currency": "GBP",
              "due_at_accommodation_amount": "39.95",
              "deal_types": [
                "closed_user_group",
                "mobile"
              ],
              "conditions": [
                {
                  "title": "Parking",
                  "description": "Public parking is available nearby for £15 per day"
                }
              ],
              "cancellation_timeline": [
                {
                  "refund_amount": "799.00",
                  "currency": "GBP",
                  "before": "2023-05-23T13:00:00Z"
                }
              ],
              "board_type": "room_only",
              "base_currency": "GBP",
              "base_amount": "665.83",
              "available_payment_methods": [
                [
                  "balance",
                  "card"
                ]
              ]
            }
          ],
          "photos": [
            {
              "url": "https://assets.duffel.com/img/stays/image.jpg"
            }
          ],
          "name": "Double Suite",
          "beds": [
            {
              "type": "king",
              "count": 2
            }
          ]
        }
      ],
      "review_score": 8.8,
      "rating": 3,
      "photos": [
        {
          "url": "https://assets.duffel.com/img/stays/image.jpg"
        }
      ],
      "phone_number": "+442074938181",
      "name": "Duffel Test Hotel",
      "location": {
        "geographic_coordinates": {
          "longitude": -0.1416,
          "latitude": 51.5071
        },
        "address": {
          "region": "England",
          "postal_code": "EC2A 4TP",
          "line_one": "100 Clifton Street",
          "country_code": "GB",
          "city_name": "London"
        }
      },
      "key_collection": {
        "instructions": "Please collect the keys from accommodation's reception."
      },
      "id": "acc_0000AWr2VsUNIF1Vl91xg0",
      "email": "reservations@duffel-hotel-group.com",
      "description": "Ornate quarters, some with grand pianos, in a luxurious hotel offering acclaimed dining & a spa.",
      "check_in_information": {
        "check_out_before_time": "11:30",
        "check_in_after_time": "14:30"
      },
      "chain": {
        "name": "Duffel Hotel Group"
      },
      "brand": {
        "name": "Duffel Test",
        "id": "bra_0000Alr8BYNsbmDMThHSbI"
      },
      "amenities": [
        {
          "type": "parking",
          "description": "Parking"
        }
      ]
    }
  }
}