Modify Reservation

curl --request PATCH \
  --url https://sandbox.travel.selfbook.com/rest/v1/reservation/{reservation_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment": {
    "guest": {
      "cvv": "123",
      "token": "01JECWTWR109MQKG55E58HK52J"
    }
  }
}
'

{
  "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": "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": {
      "cvv": "123",
      "token": "01JECWTWR109MQKG55E58HK52J"
    }
  },
  "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"
}

{
  "code": 2001,
  "details": [
    {
      "message": "token is missing",
      "field": [
        "payment",
        "guest",
        "token"
      ]
    }
  ],
  "message": "Unable to process your request. Missing or invalid request parameters.",
  "type": "VALIDATION"
}

PATCH

rest

reservation

{reservation_id}

curl --request PATCH \
  --url https://sandbox.travel.selfbook.com/rest/v1/reservation/{reservation_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment": {
    "guest": {
      "cvv": "123",
      "token": "01JECWTWR109MQKG55E58HK52J"
    }
  }
}
'

{
  "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": "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": {
      "cvv": "123",
      "token": "01JECWTWR109MQKG55E58HK52J"
    }
  },
  "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"
}

{
  "code": 2001,
  "details": [
    {
      "message": "token is missing",
      "field": [
        "payment",
        "guest",
        "token"
      ]
    }
  ],
  "message": "Unable to process your request. Missing or invalid request parameters.",
  "type": "VALIDATION"
}

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

Path Parameters

reservation_id

string

required

id of the reservation

Body

application/json

check_in_date

string

ISO 8601.

Example:

"2024-05-20"

check_out_date

string

ISO 8601.

Example:

"2024-05-25"

payment

object

Payment object

Show child attributes

rate

object

Rate object. Include this when modifying reservation dates. This is the rate corresponding to the modified dates.

Show child attributes

Response

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

Show child attributes

custom_data

object

Custom data object. Returned only if included in CreateReservationRequest.

Show child attributes

created_at

string

ISO 8601.

Example:

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

guests

object

Show child attributes

hotel

object

Show child attributes

string

32-character alphanumeric Selfbook identifier.

Example:

"ZHPOGBXVQVFRVXXCHXRJATLEJWKNBERS"

payment

object

Show child attributes

Example:

{
  "guest": {
    "cvv": "123",
    "token": "01JECWTWR109MQKG55E58HK52J"
  }
}

rate

object

Show child attributes

status

enum<string>

Available options:

CANCELED,

CONFIRMED,

CREATED

Example:

"CONFIRMED"

Create Reservation Cancel Reservation

Get Started

Search Use Cases

Booking Use Cases

Reservation Modification Use Cases

API Documentation

Webhooks

API Reference

Changelog

Authorizations

Path Parameters

Body

Response