### GET /accounts and POST /accounts Source: https://beds24.com/api/v2/apiV2 Manages account information. The GET method retrieves accounts, with options to include sub-accounts, usage data, and specific languages. The POST method allows for the creation or modification of accounts. ```APIDOC GET /accounts tags: - Accounts summary: Alpha - Get accounts security: - token: [] - organization: [] parameters: - name: includeSubAccounts in: query schema: type: boolean - name: includeUsage in: query schema: type: boolean - name: includeLanguages in: query schema: type: array items: type: string enum: - "all" - "en" - "ar" - "bg" - "ca" - "cs" - "da" - "de" - "el" - "es" - "et" - "fi" - "fr" - "hr" - "he" - "hu" - "id" - "is" - "it" - "ja" - "ko" - "lt" - "mn" - "my" - "nl" - "no" - "pl" - "pt" - "ro" - "ru" - "sk" - "sl" - "sr" - "sv" - "th" - "tr" - "vi" - "zh" - "zt" responses: '200': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' X-RequestCost: $ref: '#/components/headers/X-RequestCost' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulApiResponse' - properties: type: type: string example: "account" pages: $ref: '#/components/schemas/pages' data: type: array items: $ref: '#/components/schemas/account' '400': description: Unsuccesful operation content: application/json: schema: $ref: '#/components/schemas/UnsuccessfulApiResponse' POST /accounts tags: - Accounts summary: Alpha - Create or modify accounts security: - token: [] - organization: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/account' responses: '201': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' ``` -------------------------------- ### Beds24 API V2 Authentication Endpoints Source: https://beds24.com/api/v2/index Manage authentication tokens and retrieve details about the current token. Includes methods for getting token information, setting up refresh tokens using invite codes, and managing authentication tokens. ```APIDOC GET /authentication/details - Get information about a token and diagnostics. GET /authentication/setup - Get a refresh token using an invite code. GET /authentication/token - Get an authentication token using a refresh token. DELETE /authentication/token - Delete a refresh token. ``` -------------------------------- ### Authentication Setup: Get Refresh Token Source: https://beds24.com/api/v2/apiV2 Retrieves a refresh token using an invite code. Refresh tokens do not expire as long as they are used within 30 days. Requires an invite code and optionally a device name in the header. ```APIDOC GET /authentication/setup Parameters: code (header, required): string - Invite code. deviceName (header, optional): string - Device name. Responses: 200: Successful operation Headers: X-FiveMinCreditLimit: integer - Credit limit for 5 minutes. X-FiveMinCreditLimit-ResetsIn: integer - Time until credit limit resets. X-FiveMinCreditLimit-Remaining: integer - Remaining credit. X-RequestCost: integer - Cost of the request. Content: application/json: schema: refreshToken 400: Unsuccessful operation Content: application/json: schema: UnsuccessfulApiResponse ``` -------------------------------- ### Get Room Offers API Source: https://beds24.com/api/v2/apiV2 Retrieves room offers based on specified criteria such as property ID, room ID, dates, and occupancy. Supports filtering by offer ID, agent code, and includes optional descriptive texts in a specified language. Pagination is also supported. ```APIDOC GET /inventory/rooms/offers Summary: Get offer based on specified criteria Tags: - Inventory Parameters: - name: propertyId in: query schema: type: array items: type: integer - name: roomId in: query schema: type: array items: type: integer - name: offerId in: query schema: type: array items: type: integer - name: arrival in: query required: true schema: type: string - name: departure in: query required: true schema: type: string - name: numAdults in: query required: true schema: type: integer - name: numChildren in: query schema: type: integer - name: includeTexts description: "includes descriptive texts in response for specified language. Use 2 character country code: ```?includeTexts=en```" in: query schema: type: array items: type: string minLength: 2 maxLength: 2 example: "" - name: agentCode in: query schema: type: string - name: page in: query description: "Page number for pagination" schema: type: integer Responses: '200': description: Successful operation headers: X-FiveMinCreditLimit: description: "Available credit limit for the next 5 minutes" X-FiveMinCreditLimit-ResetsIn: description: "Time in seconds until the credit limit resets" X-FiveMinCreditLimit-Remaining: description: "Remaining credit limit for the current 5-minute window" X-RequestCost: description: "Cost of the current request in credits" content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulApiResponse' - properties: type: type: string example: "offer" pages: $ref: '#/components/schemas/pages' data: type: array items: type: object properties: roomId: type: integer propertyId: type: integer offers: type: array items: $ref: '#/components/schemas/offerResponse' '400': description: Unsuccesful operation content: application/json: schema: $ref: '#/components/schemas/UnsuccessfulApiResponse' ``` -------------------------------- ### Beds24 API V2 Channels Settings Source: https://beds24.com/api/v2/index Configure settings for various channels. Includes endpoints to retrieve and set channel-specific configurations. ```APIDOC GET /channels/settings - Alpha - Get channel settings. POST /channels/settings - Alpha - Set channel settings. ``` -------------------------------- ### Get Stripe Payment Methods Source: https://beds24.com/api/v2/apiV2 Retrieves a list of Stripe payment methods associated with a booking. The response may include additional data from Stripe's API not explicitly detailed in the examples. ```APIDOC /channels/stripe/paymentMethods get: summary: List Stripe Payment Methods description: Retrieves Stripe payment methods for a booking. Note: the response will include additional data from Stripe's API that is not specified in the example. tags: - Channels - Stripe security: - token: [] - organization: [] parameters: - name: bookingId in: query required: true description: The ID of the booking to retrieve payment methods for. schema: type: integer - name: stripePaymentMethodId in: query required: false description: Optional. Filter by a specific Stripe PaymentMethod ID. schema: type: string responses: '201': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' X-RequestCost: $ref: '#/components/headers/X-RequestCost' content: application/json: schema: type: array items: allOf: - type: object - $ref: '#/components/schemas/multiplePostResponse' ``` -------------------------------- ### Booking.com Channel API Source: https://beds24.com/api/v2/index Endpoints for interacting with Booking.com, including fetching reviews and performing general actions. ```APIDOC Booking.com Channel API: GET /channels/booking/reviews - Description: Gets reviews from Booking.com. - Parameters: None specified. - Returns: Reviews data. POST /channels/booking - Description: Perform actions at Booking.com. - Parameters: Action-specific payload required. - Returns: Result of the performed action. ``` -------------------------------- ### Beds24 API v2 Configuration and Usage Schema Source: https://beds24.com/api/v2/apiV2 This documentation outlines the structure of configuration parameters and usage statistics provided by the Beds24 API v2. It details various settings like date formats, template options, and usage metrics such as the number of properties, rooms, and channel links. ```APIDOC dateFormat: type: string decimalPlaces: type: string deduceLanguage: type: string exportData: type: string oneTimeVouchers: type: string hidePages: type: string hideSettings: type: string readonlyPages: type: string subControlCss: type: string subControlText: type: string subHidePages: type: string subHideSettings: type: string subReadonlyPages: type: string template1: type: string template2: type: string template3: type: string template4: type: string template5: type: string template6: type: string template7: type: string template8: type: string timezone: type: string unitStatusValues: type: array items: type: string windowStyle: type: string usage: type: object properties: numProperties: type: integer format: int32 numRooms: type: integer format: int32 numRoomTypes: type: integer format: int32 numActivities: type: integer format: int32 numLinks: type: integer format: int32 channelLinks: type: object description: Channels with no active links will not be shown here properties: agoda: type: integer minimum: 1 airbnb: type: integer minimum: 1 airbnbical: type: integer minimum: 1 atraveode: type: integer minimum: 1 bedandbreakfasteu: type: integer minimum: 1 bedandbreakfastnl: type: integer minimum: 1 bookitconz: type: integer minimum: 1 bookeasycomau: type: integer minimum: 1 booking: type: integer minimum: 1 despegar: type: integer minimum: 1 edreamsodigeo: type: integer minimum: 1 expedia: type: integer minimum: 1 feratel: type: integer minimum: 1 flipkey: type: integer minimum: 1 goibibo: type: integer minimum: 1 googlecal: type: integer minimum: 1 googleads: type: integer minimum: 1 holidaylettingscouk: type: integer minimum: 1 hometogo: type: integer minimum: 1 hostelinternational: type: integer minimum: 1 hostelsclub: type: integer minimum: 1 hostelworld: type: integer minimum: 1 hotelbeds: type: integer minimum: 1 housetripcom: type: integer minimum: 1 hrs: type: integer minimum: 1 icalimport1: type: integer minimum: 1 icalimport2: type: integer minimum: 1 icalimport3: type: integer minimum: 1 jomres: type: integer minimum: 1 lastminute: type: integer minimum: 1 marriott: type: integer minimum: 1 nzaa: type: integer minimum: 1 ostrovokru: type: integer minimum: 1 ota: type: integer minimum: 1 reserva: type: integer minimum: 1 rezintelnet: type: integer minimum: 1 tablethotels: type: integer minimum: 1 ``` -------------------------------- ### Get Airbnb User IDs (GET /channels/airbnb/users) Source: https://beds24.com/api/v2/apiV2 Retrieves a list of all Airbnb user IDs connected to the authenticated account. This endpoint is useful for managing or verifying Airbnb integrations. It returns a successful response with an array of user identifiers. ```APIDOC GET /channels/airbnb/users summary: Beta - Get all Airbnb user ids connected to an account tags: - Channels - Airbnb security: - token: [] - organization: [] responses: '200': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' X-RequestCost: $ref: '#/components/headers/X-RequestCost' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulApiResponse' - properties: type: type: string example: "airbnbUser" pages: $ref: '#/components/schemas/pages' ``` -------------------------------- ### Beds24 API V2 Properties Management Source: https://beds24.com/api/v2/index Endpoints for managing property and room information. Includes fetching property and room details, and creating or modifying properties. Some operations are marked as 'Coming soon'. ```APIDOC GET /properties - Beta - Get properties matching specified criteria. GET /properties/rooms - Coming soon - Get rooms matching specified criteria. POST /properties - Beta - Create or modify properties. DELETE /properties - Coming soon - Delete properties by id. DELETE /properties/rooms - Coming soon - Delete rooms by id. ``` -------------------------------- ### Create Bookings and Group Them Source: https://beds24.com/api/v2/apiV2 Creates two new bookings and assigns them to a group. Supports specifying room, status, dates, and comments for each booking, along with a flag to initiate grouping. ```JSON [ { "roomId": 1234567, "status": "confirmed", "arrival": "2021-01-01", "departure": "2021-01-05", "actions": { "makeGroup": true } }, { "roomId": 7654321, "status": "confirmed", "arrival": "2021-01-05", "departure": "2021-01-12", "comment": "Part of a group booking" } ] ``` -------------------------------- ### Bookings API (GET, POST) Source: https://beds24.com/api/v2/apiV2 Provides endpoints for managing bookings. The GET endpoint allows fetching bookings with various filtering and inclusion options. The POST endpoint enables the creation of new bookings or updating existing ones, including associated info items. ```APIDOC GET /bookings Summary: Get bookings Description: Retrieves a list of bookings based on specified criteria. Parameters: - name: id in: query schema: type: integer description: Gets bookings with this ID. - name: modifiedFrom in: query schema: type: string format: date-time description: Gets bookings with a modified datetime after this. YYYY-MM-DDTHH:MM:SS - name: modifiedTo in: query schema: type: string format: date-time description: Gets bookings with a modified datetime before this. YYYY-MM-DDTHH:MM:SS - name: searchString in: query schema: type: string description: Gets bookings where the guest name, email, apiref or bookingId fields match this parameter. - name: includeInvoiceItems in: query schema: type: boolean - name: includeInfoItems in: query schema: type: boolean - name: includeGuests in: query schema: type: boolean description: Guest data requires the bookings-personal scope - name: includeBookingGroup in: query schema: type: boolean description: Returns the bookingGroup field, which contains IDs of other bookings in the booking group - name: status in: query schema: type: array items: type: string enum: - confirmed - request - new - cancelled - black - inquiry description: Will default to "confirmed", "request", "new", "black" and "inquiry" if not specified - $ref: '#/components/parameters/page' Security: - token: [] - organization: [] Responses: '200': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' X-RequestCost: $ref: '#/components/headers/X-RequestCost' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulApiResponse' - properties: type: type: string example: "booking" pages: $ref: '#/components/schemas/pages' data: type: array items: allOf: - type: object - $ref: '#/components/schemas/booking' - $ref: '#/components/schemas/bookingGuests' - $ref: '#/components/schemas/bookingActions' '400': description: Unsuccesful operation content: application/json: schema: $ref: '#/components/schemas/UnsuccessfulApiResponse' POST /bookings Tags: - Bookings Summary: Create or update bookings Description: | To add a new info item to a booking, include it without an info item id To modify an info item, include the info item id with the code and/or text fields To delete an info item, include only the info item id RequestBody: content: application/json: schema: type: array items: allOf: - properties: id: type: integer description: Required to update an existing booking - $ref: '#/components/schemas/newBooking' - $ref: '#/components/schemas/bookingActions' examples: newBooking: summary: Create a new booking value: [ { "roomId": 1234567, "status": "confirmed", "arrival": "2021-01-01", "departure": "2021-01-05", "numAdult": 2, "numChild": 1, "title": "Mr", "firstName": "John", "lastName": "Doe", "email": "johndoe@example.com", "mobile": 123456789, "address": "123 Fake st", "city": "Melbourne", "state": "Victoria", "postcode": "3000", "country": "Australia" } ] multipleNewBookings: summary: Create multiple new bookings value: [ { "roomId": 1234567, "status": "confirmed", "arrival": "2021-01-01", "departure": "2021-01-05", "numAdult": 2, "firstName": "John", "lastName": "Doe" }, { "roomId": 1234568, "status": "request", "arrival": "2021-01-06", "departure": "2021-01-10", "numAdult": 1, "firstName": "Jane", "lastName": "Smith" } ] updateBooking: summary: Update an existing booking value: [ { "id": 12345, "status": "cancelled", "departure": "2021-01-04" } ] addInfoItem: summary: Add an info item to an existing booking value: [ { "id": 12345, "infoItems": [ { "code": "BREAKFAST", "text": "Add breakfast for 2" } ] } ] updateInfoItem: summary: Update an existing info item value: [ { "id": 12345, "infoItems": [ { "id": 111, "code": "BREAKFAST", "text": "Add breakfast for 2 adults" } ] } ] deleteInfoItem: summary: Delete an info item value: [ { "id": 12345, "infoItems": [ { "id": 111 } ] } ] ``` -------------------------------- ### GET /bookings/invoices - Get Invoices Source: https://beds24.com/api/v2/apiV2 Retrieves a list of invoices associated with bookings. This endpoint supports filtering by booking ID and includes pagination parameters. It is marked as 'Alpha', suggesting it may be experimental or subject to change. Responses include successful invoice data or error information. ```APIDOC GET /bookings/invoices summary: Alpha - Get invoices tags: - Bookings parameters: - name: bookingId in: query schema: type: array items: type: integer - $ref: '#/components/parameters/page' security: - token: [] - organization: [] ``` -------------------------------- ### Authentication Details: Get Token Information Source: https://beds24.com/api/v2/apiV2 Retrieves information about a token and diagnostics. Requires a token in the header. ```APIDOC GET /authentication/details Parameters: token (header, optional): string - Authentication token. Responses: 200: Successful operation Headers: X-FiveMinCreditLimit: integer - Credit limit for 5 minutes. X-FiveMinCreditLimit-ResetsIn: integer - Time until credit limit resets. X-FiveMinCreditLimit-Remaining: integer - Remaining credit. X-RequestCost: integer - Cost of the request. Content: application/json: schema: (Schema definition not provided in the input) ``` -------------------------------- ### Beds24 API V2 Channels Airbnb Integration Source: https://beds24.com/api/v2/index Manage Airbnb channel integration. Provides endpoints to retrieve Airbnb listings, reviews, and user IDs, as well as perform actions directly on Airbnb. ```APIDOC GET /channels/airbnb/listings - Alpha - Get all Airbnb listings for a specified Airbnb user id. GET /channels/airbnb/reviews - Beta - Gets guest reviews from Airbnb. GET /channels/airbnb/users - Beta - Get all Airbnb user ids connected to an account. POST /channels/airbnb - Alpha - Perform actions at Airbnb. ``` -------------------------------- ### Schema: iCalExportSettingsGet Source: https://beds24.com/api/v2/apiV2 Represents the GET structure for iCal export settings, inheriting from iCalExportSettingsPost and adding specific properties for retrieving export URIs. ```APIDOC iCalExportSettingsGet: allOf: - $ref: '#/components/schemas/iCalExportSettingsPost' - properties: properties: type: array items: type: object properties: roomTypes: type: array items: type: object properties: iCalUri: type: string propertyDescriptionICalUri: type: string roomDescriptionICalUri: type: string propertyAndRoomDescriptionICalUri: type: string ``` -------------------------------- ### Beds24 API v2 Guest and Custom Question Configuration Source: https://beds24.com/api/v2/apiV2 This section outlines the configuration parameters for various guest information fields and custom questions in the Beds24 API v2. Each field can be ordered and its usage defined, with custom questions also allowing specification of their input type. ```APIDOC Beds24 API v2 Guest and Custom Question Configuration: This API documentation describes the structure for configuring guest-related fields and custom questions. Common Properties for Guest Fields: - order: (integer) Specifies the display order of the field. - usage: (string) Defines how the field is used. Allowed values: - "notUsed" - "optional" - "compulsory" - "compulsoryBookingPage" - "internal" Specific Guest Fields: guestCountryText: Properties: order: integer usage: string (enum as above) guestCountrySelect: Properties: order: integer usage: string (enum as above) guestArrivalTime: Properties: order: integer usage: string (enum as above) guestComments: Properties: order: integer usage: string (enum as above) Custom Question Fields (customQuestion1 to customQuestion8): Each custom question field includes the common properties plus a 'type' property. Properties: order: integer usage: string (enum as above) type: (string) Specifies the input type for the custom question. Allowed values: - "singleLineField" - "multiLineField" - "multipleList" - "multipleSelect" - "tickBox" - "dateSelector" Example Structure for a Custom Question: customQuestion1: order: 1 usage: "compulsory" type: "singleLineField" ``` -------------------------------- ### Beds24 API v2 - Properties Endpoint Source: https://beds24.com/api/v2/apiV2 This section details the /properties endpoint for the Beds24 API v2. It supports retrieving properties based on various criteria using a GET request and creating or modifying properties via a POST request. The GET method allows filtering by property ID, language inclusion, text inclusion, picture inclusion, offer inclusion, price rule inclusion, upsell item inclusion, room details, and room ID. The POST method accepts an array of property objects for bulk operations. ```APIDOC GET /properties summary: Beta - Get properties matching specified criteria tags: - Properties parameters: - name: id description: The property ID. Multiple ids can be included. in: query schema: type: array items: type: integer - name: includeLanguages in: query schema: type: array items: type: string enum: ["all", "en", "ar", "bg", "ca", "cs", "da", "de", "el", "es", "et", "fi", "fr", "hr", "he", "hu", "id", "is", "it", "ja", "ko", "lt", "mn", "my", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl", "sr", "sv", "th", "tr", "vi", "zh", "zt"] - name: includeTexts in: query schema: type: array items: type: string enum: ["all", "property", "roomType"] - name: includePictures in: query schema: type: boolean - name: includeOffers in: query schema: type: boolean - name: includePriceRules in: query schema: type: boolean - name: includeUpsellItems in: query schema: type: boolean - name: includeAllRooms in: query schema: type: boolean - name: includeUnitDetails description: By default only unit names are returned. in: query schema: type: boolean - name: roomId in: query schema: type: array items: type: integer - $ref: '#/components/parameters/page' security: - token: [] - organization: [] responses: '200': description: Successful operation headers: X-FiveMinCreditLimit: $ref: '#/components/headers/X-FiveMinCreditLimit' X-FiveMinCreditLimit-ResetsIn: $ref: '#/components/headers/X-FiveMinCreditLimit-ResetsIn' X-FiveMinCreditLimit-Remaining: $ref: '#/components/headers/X-FiveMinCreditLimit-Remaining' X-RequestCost: $ref: '#/components/headers/X-RequestCost' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulApiResponse' - properties: type: type: string example: "property" pages: $ref: '#/components/schemas/pages' data: type: array items: $ref: '#/components/schemas/property' '400': description: Unsuccesful operation content: application/json: schema: $ref: '#/components/schemas/UnsuccessfulApiResponse' POST /properties summary: Beta - Create or modify properties tags: - Properties security: - token: [] - organization: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/property' examples: newProperty: summary: Create a new property with some basic details value: [ { "name": "My New Property", "propertyType": "apartment", "currency": "USD", "address": "123 Main St" } ] ``` -------------------------------- ### Beds24 API v2 Configuration, Headers, and Security Source: https://beds24.com/api/v2/apiV2 Details the configuration properties for various booking channels, including Jomres, Lastminute, Marriott, and others. It also specifies important request headers like credit limit tracking and request cost, query parameters for pagination, and security schemes for authentication using API tokens and organization identifiers. ```APIDOC Configuration Options: jomres: type: object properties: enabled: type: boolean rateCode: type: string lastminute: type: object properties: enabled: type: boolean rateCode: type: string marriott: type: object properties: enabled: type: boolean ostrovokru: type: object properties: enabled: type: boolean rateCode: type: string ota: type: object properties: enabled: type: boolean rateCode: type: string reserva: type: object properties: enabled: type: boolean rateCode: type: string tablethotels: type: object properties: enabled: type: boolean rateCode: type: string tiket: type: object properties: enabled: type: boolean rateCode: type: string tomastravel: type: object properties: enabled: type: boolean rateCode: type: string traumferienwohnungen: type: object properties: enabled: type: boolean traveloka: type: object properties: enabled: type: boolean rateCode: type: string travia: type: object properties: enabled: type: boolean rateCode: type: string tripadvisorrentals: type: object properties: enabled: type: boolean vacationstay: type: object properties: enabled: type: boolean vrbo: type: object properties: enabled: type: boolean webroomsconz: type: object properties: enabled: type: boolean Request Headers: X-FiveMinCreditLimit: description: The maximum number of credits you can use in a 5 minute period schema: type: integer example: 100 X-FiveMinCreditLimit-ResetsIn: description: The number of seconds until this 5 minute period is over and your credit limit resets schema: type: integer example: 100 X-FiveMinCreditLimit-Remaining: description: The remaining number of credits you have for this 5 minute period schema: type: integer example: 100 X-RequestCost: description: How many credits this request used schema: type: integer example: 100 Query Parameters: page: name: page in: query description: Get a page of items beyond the first schema: type: integer Security Schemes: token: type: apiKey name: token in: header description: | Include your token here (either a long life token or one generated using a refresh token) organization: name: organization type: apiKey in: header description: | If you are an integration partner you must include your organization name in this header with each request. If you are not an integration partner do not include this header. ``` -------------------------------- ### Vrbo Settings Schema Source: https://beds24.com/api/v2/apiV2 Defines the configuration parameters for the Vrbo channel integration. It includes channel identification, currency settings, and various property-level details such as multipliers, invoicee IDs, default language, and owner listing information. ```APIDOC vrboSettingsPost: type: object properties: channel: type: string example: vrbo currency: type: string enum: - "USD" - "AUD" - "BRL" - "CAD" - "EUR" - "GBP" - "JPY" properties: type: object properties: id: type: integer multiplier: type: number invoiceeId: type: string nullable: true defaultLanguage: type: string enum: - "de" - "en" - "es" - "fi" - "fr" - "it" - "ja" - "nl" - "no" - "pt" - "sov" showExactLanguage: type: boolean ownerListingStory: type: string uniqueBenefits: type: string whyPurchased: type: string yearPurchased: type: string acceptedPaymentType: type: string enum: - "all" - "invoiceOnly" - "cardOnly" paymentInvoiceDescription: type: string paymentSchedule: type: string ``` -------------------------------- ### Rooms API (GET) Source: https://beds24.com/api/v2/apiV2 Retrieves room information based on specified criteria. Supports filtering by room ID or property ID, and including language translations. ```APIDOC /properties/rooms get: summary: Coming soon - Get rooms matching specified criteria tags: - Properties parameters: - name: id description: The room ID. Multiple ids can be included. in: query schema: type: array items: type: integer - name: propertyId description: Gets all rooms for the specified property. Multiples ids can be included. in: query schema: type: array items: type: integer - name: includeLanguages in: query schema: type: array items: type: string enum: - "all" - "en" - "ar" - "bg" - "ca" - "cs" - "da" - "de" - "el" - "es" - "et" - "fi" - "fr" - "hr" - "he" ``` -------------------------------- ### Schema: iCalImportSettingsGet Source: https://beds24.com/api/v2/apiV2 Defines the GET structure for iCal import settings, specifying channel, property details, and room type configurations for importing calendar data. ```APIDOC iCalImportSettingsGet: type: object properties: channel: type: string example: iCalImport properties: type: array items: type: object properties: id: type: integer modificationNotification: type: string enum: - "modificationAllowedBookingNotificationOnly" - "modificationAllowedBookingCancelNotification" - "modificationAllowedNoEmailNotification" - "modificationProhibitedBookingNotificationOnly" - "modificationProhibitedNoEmailNotification" roomTypes: type: array items: type: object properties: id: type: integer iCalUri1: type: string iCalUri2: type: string iCalUri3: type: string ignoreContaining1: type: string ignoreContaining2: type: string ignoreContaining3: type: string import1: type: string enum: - "disable" - "endDateCheckout" - "endDateCheckoutIgnoreDuplicate" - "endDateCheckoutIgnoreIfUnavailable" - "endDateLastNight" - "endDateLastNightIgnoreDuplicate" - "endDateLastNightIgnoreIfUnavailable" - "endDateDayAfterCheckOut" - "endDateDayAfterCheckOutIgnoreDuplicate" - "endDateDayAfterCheckoutIgnoreIfUnavailable" import2: type: string enum: - "disable" - "endDateCheckout" - "endDateCheckoutIgnoreDuplicate" ``` -------------------------------- ### Stripe Charge and Refund Schemas Source: https://beds24.com/api/v2/apiV2 Defines the data structures for processing Stripe charges, refunds, captures, and releases. Includes details on amounts, currency, and associated booking IDs. ```APIDOC stripeChargePaymentMethod: type: object properties: action: type: string bookingId: type: integer stripePaymentMethodId: type: string capture: type: boolean amount: type: number currency: type: string description: type: string moto: type: boolean source: type: string stripeRefundCharge: type: object properties: action: type: string bookingId: type: integer stripeChargeId: type: string amount: type: number stripeReleaseCharge: type: object properties: action: type: string bookingId: type: integer stripeChargeId: type: string stripeCaptureCharge: type: object properties: action: type: string bookingId: type: integer stripeChargeId: type: string amount: type: number stripeCharge: type: object properties: stripeCharge: description: This object will contain other fields not specified here. type: object properties: id: type: string object: type: string example: "charge" amount: type: integer amount_captured: type: integer amount_refunded: type: integer billing_details: type: object properties: address: type: object properties: city: type: string country: type: string line1: type: string line2: type: string postal_code: type: string state: type: string email: type: string name: type: string phone: type: string currency: type: string paid: type: boolean payment_intent: type: string payment_method: type: string ```