Skip to main content
POST
/
rest
/
v1
/
reservation
curl --request POST \
  --url https://sandbox.travel.selfbook.com/rest/v1/reservation \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "check_in_date": "2024-05-20",
  "check_out_date": "2024-05-25",
  "guests": {
    "number_of_adults": 1,
    "number_of_children": 1,
    "primary": {
      "address": "123 Main St, Apt 152",
      "city": "Miami",
      "country": "US",
      "email": "[email protected]",
      "given_name": "John",
      "postal_code": "33123",
      "state": "FL",
      "surname": "Doe",
      "telephone_number": "+13055551234"
    }
  },
  "hotel": {
    "chain_code": "HI",
    "name": "Holiday Inn",
    "property_code": "E8597"
  },
  "payment": {
    "guest": {
      "amount": 164.24,
      "token": "01JKA2V3A58ZXN2EH5CK6B10AY"
    }
  },
  "rate": {
    "booking_code": "2QN57JU",
    "channel_code": "SBT1",
    "number_of_rooms": 1,
    "price": {
      "total_price": 164.24,
      "base_price": 139,
      "total_taxes": 25.24,
      "currency_code": "USD"
    },
    "terms": {
      "rate_payment_info": "PrePay",
      "guarantee_type": "DepositRequired",
      "refundable": true,
      "cancel_note": null,
      "cancel_penalties": [
        {
          "deadline_local": "2024-04-19T00:00-06:00",
          "cancel_short_description": "An estimated cancellation fee of 106.90 USD applies starting from 2024-04-20T00:00-06:00[America/Chicago].",
          "penalty": {
            "estimated_amount": true,
            "currency_amount": {
              "amount": 106.9,
              "currency": "USD"
            },
            "original_penalty_info": "100%"
          }
        }
      ]
    }
  }
}
'
{
  "check_in_date": "2024-05-20T00:00:00Z",
  "check_out_date": "2024-05-25T00:00:00Z",
  "confirmation": {
    "hotel_confirmation_number": "CONFIRMATION_ID",
    "record_locator": "LOCATOR_CODE"
  },
  "custom_data": {
    "key": "value"
  },
  "created_at": "2024-05-20T18:00:00Z",
  "guests": {
    "number_of_adults": 1,
    "number_of_children": 1,
    "primary": {
      "address": "123 Main Street Apt 152",
      "city": "Miami",
      "country": "US",
      "email": "[email protected]",
      "given_name": "John",
      "surname": "Doe",
      "telephone_number": "+13055551234",
      "state": "FL",
      "postal_code": "33123"
    }
  },
  "hotel": {
    "chain_code": "HI",
    "name": "Holiday Inn",
    "property_code": "E8597"
  },
  "id": "ZHPOGBXVQVFRVXXCHXRJATLEJWKNBERS",
  "payment": {
    "guest": {
      "amount": 164.24,
      "stripe": {
        "customer": "cus_TestRce2zv5tRe",
        "payment_method": "pm_Test5aAWTcmv4K1R71vVugBD"
      },
      "token": "01JKA2V3A58ZXN2EH5CK6B10AY"
    },
    "partner": {
      "amount": 20,
      "stripe": {
        "customer": "cus_Test5R5ajq0MZH",
        "payment_method": "pm_TestsWAWTcmv4K1ROuWIkGXP"
      },
      "token": "01JKA13A6TWPV9R4VPWBTAV4KS"
    }
  },
  "rate": {
    "booking_code": "2QN57JU",
    "channel_code": "SBT1",
    "number_of_rooms": 1,
    "price": {
      "base_price": 159,
      "total_price": 184.24,
      "total_taxes": 25.24,
      "currency_code": "USD"
    },
    "terms": {
      "guarantee_type": "DepositRequired",
      "rate_payment_info": "PrePay",
      "refundable": true,
      "cancel_note": "Rate returned without cancel policy requires a rule request for complete information",
      "cancel_penalties": {
        "deadline_local": "2024-09-17T00:00:00-05:00",
        "cancel_short_description": "An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago].",
        "penalty": {
          "estimated_amount": true,
          "currency_amount": {
            "amount": 177.44,
            "currency": "USD"
          },
          "original_penalty_info": "100%"
        }
      }
    }
  },
  "status": "CONFIRMED"
}

Authorizations

​
Authorization
string
header
required

Basic authentication where:

  • user-id is a partner account ID
  • user-password is an API key token associated with the partner account

Body

application/json
​
check_in_date
string
required

ISO 8601. This date will be stored in UTC but evaluated in the context of the hotel's local timezone.

Example:

"2024-05-20"

​
check_out_date
string
required

ISO 8601. This date will be stored in UTC but evaluated in the context of the hotel's local timezone.

Example:

"2024-05-25"

​
guests
object
required
​
hotel
object
required
​
payment
object
required
​
rate
object
required
​
custom_data
object

Optional, custom object. Use to include additional data with the reservation. This data is not passed to hotels and will only be stored with Selfbook. Allows up to 5 key value pairs.

Keys have a max-length of 32 characters. Allowable characters are letters, numbers, underscore(_) or hyphen (-).

Values can be strings, numbers, or booleans. Max-length of 128 characters. Allowable characters are any except: greater-than symbol (>), less-than symbol (<), double quote("), single quote(') or backslash (\).

​
customer_loyalty
object

Optional. Customer Loyalty details

Response

Created

​
check_in_date
string

ISO 8601.

Example:

"2024-05-20T00:00:00Z"

​
check_out_date
string

ISO 8601.

Example:

"2024-05-25T00:00:00Z"

​
confirmation
object
​
custom_data
object

Custom data object. Returned only if included in CreateReservationRequest.

​
created_at
string

ISO 8601.

Example:

"2024-05-20T18:00:00Z"

​
guests
object
​
hotel
object
​
id
string

32-character alphanumeric Selfbook identifier.

Example:

"ZHPOGBXVQVFRVXXCHXRJATLEJWKNBERS"

​
payment
object
​
rate
object
​
status
enum<string>
Available options:
CANCELED,
CONFIRMED,
CREATED
Example:

"CONFIRMED"