### GET /listings Source: https://dynamic-api-docs.beyondpricing.com/ Fetch all listings from the PMS. Supports sorting by newly created listings and parent-child hierarchy for multi-unit properties. ```APIDOC ## GET /listings ### Description Retrieves a list of all properties/listings managed by the PMS. For multi-unit structures, parent units should be sorted first. ### Method GET ### Endpoint /listings ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort order (e.g., 'created_at', 'parent_id') ### Response #### Success Response (200) - **listings** (array) - List of listing objects - **id** (string) - Unique identifier - **type** (string) - 'parent' or 'child' ### Response Example { "listings": [ { "id": "parent_123", "type": "parent", "title": "Ocean View 2-Bedroom" } ] } ``` -------------------------------- ### Fetch Reservations Source: https://dynamic-api-docs.beyondpricing.com/ Retrieves reservations by listing ID. Supports filtering by check-out start date and check-in start date. Prioritizes check-out date filtering. ```APIDOC ## GET /reservations ### Description Fetches reservations by listing ID. Supports filtering by check-out start date and check-in start date. The check-out start date parameter is preferred for filtering. ### Method GET ### Endpoint /reservations ### Parameters #### Query Parameters - **listing_id** (string) - Required - The ID of the listing to fetch reservations for. - **check_out_start_date** (string) - Optional - Filters reservations with check-out dates starting from this date (YYYY-MM-DD). - **check_in_start_date** (string) - Optional - Filters reservations with check-in dates starting from this date (YYYY-MM-DD). ### Request Example ``` GET /reservations?listing_id=LISTING123&check_out_start_date=2024-01-01 ``` ### Response #### Success Response (200) - **reservations** (array) - A list of reservation objects. - **reservation_id** (string) - The ID of the reservation. - **check_in_date** (string) - The check-in date of the reservation. - **check_out_date** (string) - The check-out date of the reservation. - **guest_name** (string) - The name of the guest. #### Response Example ```json { "reservations": [ { "reservation_id": "RES456", "check_in_date": "2024-01-10", "check_out_date": "2024-01-15", "guest_name": "John Doe" } ] } ``` ``` -------------------------------- ### GET /listings/{id}/calendar Source: https://dynamic-api-docs.beyondpricing.com/ Fetch the calendar data for a specific listing, including availability, prices, and minimum stay requirements. ```APIDOC ## GET /listings/{id}/calendar ### Description Returns the calendar availability and pricing data for a listing. Note: Parent listings should return an empty list for availability/reservations. ### Method GET ### Endpoint /listings/{id}/calendar ### Parameters #### Path Parameters - **id** (string) - Required - The unique ID of the listing ### Response #### Success Response (200) - **calendar** (array) - List of daily objects - **date** (string) - ISO 8601 date - **price** (number) - Daily rate - **min_nights** (integer) - Minimum stay requirement ### Response Example { "calendar": [ { "date": "2025-03-01", "price": 200.00, "min_nights": 2, "available": true } ] } ``` -------------------------------- ### POST /listings/{id}/rates Source: https://dynamic-api-docs.beyondpricing.com/ Push updated daily rates, minimum nights, and check-in/out rules to the PMS. ```APIDOC ## POST /listings/{id}/rates ### Description Updates pricing and stay restrictions for a listing. For multi-unit structures, Beyond pushes to the parent, and the PMS must propagate these to all child listings. ### Method POST ### Endpoint /listings/{id}/rates ### Request Body - **price** (number) - Required - New daily rate - **min_nights** (integer) - Optional - New minimum stay ### Request Example { "price": 250.00, "min_nights": 3 } ### Response #### Success Response (200) - **status** (string) - 'success' ``` -------------------------------- ### Authorization Source: https://dynamic-api-docs.beyondpricing.com/ Information on how to authorize API requests using an API key. ```APIDOC ## Authorization ### Description API requests must be authorized using an API key. The key should be included in the request headers. ### Method All Methods ### Endpoint All Endpoints ### Parameters #### Request Headers - **x-api-key** (string) - Required - Your unique API key. ### Request Example ``` GET /reservations Host: api.example.com x-api-key: PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96 ``` ``` -------------------------------- ### Fetch Reservation by ID Source: https://dynamic-api-docs.beyondpricing.com/ Retrieves a specific reservation using its unique ID. ```APIDOC ## GET /reservations/{reservation_id} ### Description Fetches a specific reservation by its unique ID. ### Method GET ### Endpoint /reservations/{reservation_id} ### Parameters #### Path Parameters - **reservation_id** (string) - Required - The unique identifier of the reservation. ### Request Example ``` GET /reservations/RES456 ``` ### Response #### Success Response (200) - **reservation_id** (string) - The ID of the reservation. - **check_in_date** (string) - The check-in date of the reservation. - **check_out_date** (string) - The check-out date of the reservation. - **guest_name** (string) - The name of the guest. #### Response Example ```json { "reservation_id": "RES456", "check_in_date": "2024-01-10", "check_out_date": "2024-01-15", "guest_name": "John Doe" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.