Key Collection API Generic Methods

To use Key Collection API, you will first need to retrieve stream variations and check-in method names. Endpoints described in this section will help you.

Retrieve stream variations

HTTP Request

GET https://supply-xml.booking.com/checkin-methods-api/stream-variations

Response

Response contains a json with stream_variations array. Use these stream variation names when creating check-in methods.

Response example

    {
        "warnings": [],
        "meta": {
            "ruid": "UmFuZG9tSVYkc2RlIyh9Yf+oYkeY5HY2vKDu7dOshHIx5lx/ROVFWAgex2MvzzarlFpvT31/0FvEkOLoBd1WBu1rRIxBmVxuCBJS96ufy1g="
        },
        "data": {
            "stream_variations": [
                {
                    "description": "Alternative method of checkin to the property",
                    "name": "alternative_checkin_method"
                },
                {
                    "description": "Primary method of checkin to the property",
                    "name": "primary_checkin_method"
                }
            ]
        },
        "errors": []
    }

Retrieve check-in methods

HTTP Request

GET https://supply-xml.booking.com/checkin-methods-api/stream-variations

Response

Response contains a json with stream_variations array. Use these stream variation names when creating check-in methods.

URL-Parameters

Name	Type	Value
stream_variation_name	String	Stream variation name that you received from the stream-variations call

Request example

GET https://supply-xml.booking.com/checkin-methods-api/checkin-methods?stream_variation_name=primary_checkin_method

Response example

    {
        "errors": [],
        "data": {
            "checkin_methods": [
                {
                    "name": "reception",
                    "description": "The keys are at the reception"
                },
                {
                    "name": "someone_will_meet",
                    "description": "Someone will meet the guest"
                },
                {
                    "description": "There is a door code",
                    "name": "door_code"
                },
                {
                    "description": "The keys are in a lock box",
                    "name": "lock_box"
                },
                {
                    "description": "We will send instructions",
                    "name": "instruction_will_send"
                },
                {
                    "name": "instruction_contact_us",
                    "description": "Contact us for instructions"
                },
                {
                    "name": "secret_spot",
                    "description": "The keys are hidden in a secret location"
                },
                {
                    "name": "other",
                    "description": "Other"
                }
            ]
        },
        "meta": {
            "ruid": "UmFuZG9tSVYkc2RlIyh9Yf+oYkdY5HY2vVZKIC7zmK2KtrBKoL76G9pDdO74aTQ405aVTgn9nqJmAJgUIJKx09Z9KoIqRVfpUKZqdjHuw2o="
        },
        "warnings": []
    }