{
    "openapi": "3.1.0",
    "info": {
        "title": "Harbour Row Stays UCP REST binding",
        "version": "2026-08-25",
        "description": "Reference test stores. Nothing here is for sale: test cards only, no goods ship."
    },
    "servers": [
        {
            "url": "https://stays.ucpsandbox.com/ucp"
        }
    ],
    "paths": {
        "/common/locations/lookup": {
            "post": {
                "operationId": "lookup_locations",
                "parameters": [
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/2026-08-25/schemas/common/location_lookup.json#/$defs/lookup_response"
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "https://ucp.dev/2026-08-25/schemas/common/location_lookup.json#/$defs/lookup_request"
                            }
                        }
                    }
                }
            }
        },
        "/search": {
            "get": {
                "operationId": "search_properties",
                "description": "Not part of UCP: the store's own room and rate search (query: location, start_date, end_date, adults, children).",
                "parameters": [
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/booking-sessions": {
            "post": {
                "operationId": "create_booking_session",
                "parameters": [
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/booking-sessions/{id}": {
            "get": {
                "operationId": "get_booking_session",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "update_booking_session",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/booking-sessions/{id}/complete": {
            "post": {
                "operationId": "complete_booking_session",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/booking-sessions/{id}/cancel": {
            "post": {
                "operationId": "cancel_booking_session",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "https://ucp.dev/draft/schemas/lodging/booking.json"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/bookings/{id}": {
            "get": {
                "operationId": "get_booking",
                "description": "Store extension: a confirmed booking by id or confirmation number.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/bookings/{id}/cancel": {
            "post": {
                "operationId": "cancel_booking",
                "description": "Store extension: cancel a confirmed booking under its policy.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "UCP-Agent",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Request-Id",
                        "in": "header",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}