Get Started
Search Use Cases
Booking Use Cases
Reservation Modification Use Cases
API Documentation
Webhooks
API Reference
Changelog
Create Reservation
Creates a 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": "guest@somedomain.com",
"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"
},
"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": "guest@somedomain.com",
"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
Basic authentication where:
- user-id is a partner account ID
- user-password is an API key token associated with the partner account
Body
ISO 8601.
"2024-05-20"
ISO 8601.
"2024-05-25"
Number of adults.
1
Number of children.
1
Address.
"123 Main Street Apt 152"
City.
"Miami"
ISO 3166-1 alpha-2 Country code.
"US"
Primary guest first name.
Email.
"guest@somedomain.com"
Primary guest last name.
"Doe"
Phone number.
"+13055551234"
ISO 3166-2 province/region/state/subdivision.
"FL"
Postal code.
"33123"
Payment information for the guest.
Amount charged to the payment instrument represented by 'stripe' or 'token' attributes. Currency used will be the rate.price.currency_code.
164.24
Card security code. This is optional. Only pass this when reusing a Spreedly token.
"123"
Stripe payment details. Pass this instead of 'token' if you intend to use a specific Stripe customer and payment method.
A token representing the guest's payment method. Accepts Spreedly payment method tokens.
"01JKA2V3A58ZXN2EH5CK6B10AY"
Payment information for a 2nd payer. If using a partner, you must also include a guest.
Amount charged to the payment instrument represented by 'stripe' or 'token' attributes. Currency used will be the rate.price.currency_code.
20
Card security code. This is optional. Only pass this when reusing a Spreedly token.
"123"
Stripe payment details. Pass this instead of 'token' if you intend to use a specific Stripe customer and payment method.
A token representing the 2nd payer's payment method. Accepts Spreedly payment method tokens.
"01JKA13A6TWPV9R4VPWBTAV4KS"
Unique booking code.
"2QN57JU"
Channel code.
"SBT1"
Number of rooms requested.
1
Description of rate.
Description of room.
Type of guarantee required
"DepositRequired"
Type of rate payment (usually PrePay or PostPay)
"PrePay"
Is the rate refundable?
true
Note included for cancel penalties. May or may not be null.
""
Penalties for cancellation
Local date time deadline for when the cancellation fee will be enforced
"2024-09-17T00:00:00-05:00"
Short description of the cancellation policy and penalties
"An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago]."
Object describing the penalty amount.
Is the penalty amount estimated?
true
Amount of currency for the penalty
Original penalty information
"100%"
Response
ISO 8601.
"2024-05-20T00:00:00Z"
ISO 8601.
"2024-05-25T00:00:00Z"
Hotel's confirmation id. This is returned only if Reservation status is CONFIRMED.
"CONFIRMATION_ID"
Additional identifer for the reservation. This is returned only if Reservation status is CONFIRMED.
"LOCATOR_CODE"
ISO 8601.
"2024-05-20T18:00:00Z"
Number of adults.
1
Number of children.
1
Address.
"123 Main Street Apt 152"
City.
"Miami"
ISO 3166-1 alpha-2 Country code.
"US"
Email.
"guest@somedomain.com"
Primary guest first name.
"John"
Primary guest last name.
"Doe"
Phone number.
"+13055551234"
ISO 3166-2 province/region/state/subdivision.
"FL"
Postal code.
"33123"
32-character alphanumeric Selfbook identifier.
"ZHPOGBXVQVFRVXXCHXRJATLEJWKNBERS"
Amount charged to the payment instrument represented by guest payment method.
164.24
A token representing the guest payment method. This is not returned if a stripe object is returned.
"01JKA2V3A58ZXN2EH5CK6B10AY"
Amount charged to the payment instrument represented by a 2nd payer's payment method. This is included only if included when creating a reservation.
20
A token representing a 2nd payer's payment method. This is not returned if a stripe object is returned.
"01JKA13A6TWPV9R4VPWBTAV4KS"
Unique booking code.
"2QN57JU"
Channel code for room rate
"SBT1"
Number of rooms requested.
1
Type of guarantee required
"DepositRequired"
Type of rate payment (usually PrePay or PostPay)
"PrePay"
Is the rate refundable?
Note left if cancel penalties are unavailable
"Rate returned without cancel policy requires a rule request for complete information"
Penalties for cancellation
Local date time deadline for when the cancellation fee will be enforced
"2024-09-17T00:00:00-05:00"
Short description of the cancellation policy and penalties
"An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago]."
Object describing the penalty amount.
Is the penalty amount estimated?
true
Amount of currency for the penalty
Original penalty information
"100%"
CANCELED, CONFIRMED, CREATED "CONFIRMED"
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": "guest@somedomain.com",
"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"
},
"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": "guest@somedomain.com",
"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"
}