{"info":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","description":"

How to integrate your Property Management Software (PMS) with Beyond Pricing?

Our API documentation defines exactly what is needed to make Beyond accessible for our partners who have built an In-house pms. We have eliminated the complex and time consuming elements of connecting your pms and can now provide a seamless solution for you as long as you match our specifications. Not only will our two systems work in harmony, you can also take advantage of the following:

More timeline control with reduced dependency on roadmap priorities
\n
Solution for a Pilot prior to contract
\n
Automated validation process
\n

What is ‘Building to Spec’?

When our partners manufacture a ‘product’ (in this case PMS) that meets specific parameters outlined in our documentation regarding how our two systems operate and communicate. **This document describes what data we expect and what your endpoints should look like. The API is organized around REST.

Definitions

Account

The account is what identifies a specific customer on the PMS.

Property/Listing

Each listing has its own availability, reservations, daily prices, and etc.

A property can have several listings in the case of multi-units properties but each listing must be treated as an independent listing with its own data.

Beyond Pricing works at the listing level and expects to receive the information at the listing level (availability, reservations, etc), not at the Property level.

NEW - Multi Unit Support

What’s Changing: The Beyond API now supports multi-unit structure (commonly referred to as parent-child, room type, hotel-style, or unit groups)
Effective Date: 2025-03-01
Deprecation Date: Not Applicable, there are no breaking changes
Required Action: Update your integration if multi-unit support is applicable to your system
What is Multi Unit? A listing with multiple units in a group ie parent/child that have the same attributes, location and pricing. Think similar apartments in the same building, or identical rooms under the same room type/category. The \"Parent\" listing is the main listing, and the \"Child\" listing is grouped under the Parent. This structure makes it easy to manage multiple similar listings while keeping track of individual reservations and availability.

Example:

Parent: title \"Ocean View 2-Bedroom\"
\n
- Child 1: title \"Ocean View 2-Bedroom - Unit 101\"
  \n
- Child 2: title \"Ocean View 2-Bedroom - Unit 102\"
  \n
\n

Key Points:

The Parent listing (or Room Type) is just an organizational tool to group the child listings
\n
Each child listing has their own calendar availability and assigned reservations (all listings sync to Beyond and group automatically)
\n
Prices are set at the Parent and the Property Management System (PMS) Software has the responsibility to send prices to all Child listings
\n

Authentication

We will need an API key for each account.

The API keys are issued on your end.

We can pass the key in the header of the request (x-api-key) to identify the account.

Data flow

During the initial account sync, we will fetch all listings along with their availability, rates and reservations.

After that, we will fetch this data daily to look for updates.

We will also post rates daily or after a user triggers a manual sync.

Main API requests

Account

fetch account information

Listing

Pull

fetch all listings. Sort by newly created listings. NEW: Beyond now supports multi-unit Parent-Child structure. If you use that organizational tool, you should sort by Parent units IDs first.
\n
fetch a listing by ID
\n
If we fetch a listing and it doesn't exist for 2 days in a row we will delete it in Beyond
\n
fetch the listing's calendar
\n
- per day, at least 365 days, more is better
  \n
- includes: prices, minimum nights, check-in/checkout days, availability
  \n
- NEW (Effective Date: 2025-03-01): Beyond now supports multi-unit Parent-Child structure. Availabilty/calendar should be at the Child listing level, Parent listings should not return any availability or reservations data, ie, should return empty list.
  \n
\n

Provide at least one year (more is better) for every piece of data that is per date (availability, prices, etc.)

Push

push daily price, minimum nights, check-in and check-out days.
\n
NEW (Effective Date: 2025-03-01): Beyond now supports multi-unit Parent-Child structure. Beyond push rates at the Parent listing level. NOTE: It is the PMS responsibility to send prices to all Child listings of the same Parent.
\n

Reservation

Pull

fetch reservations by listing ID. Request should be able to take a param check-out start date to allow filtering reservations with check-out date starting from that date. Check-in start date param can also be passed to allow filtering of reservations with check-in date starting from that date. Preferred to use check-out start date filter param.
\n
NEW (Effective Date: 2025-03-01): Beyond now supports multi-unit Parent-Child structure. Unique calendars with reservations should be at the Child listing level, Parent listings should not return any reservations or availability data.
\n
fetch a reservation by ID
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"How to integrate your Property Management Software (PMS) with Beyond Pricing?","slug":"how-to-integrate-your-property-management-software-pms-with-beyond-pricing"},{"content":"Definitions","slug":"definitions"},{"content":"Authentication","slug":"authentication"},{"content":"Data flow","slug":"data-flow"},{"content":"Main API requests","slug":"main-api-requests"}],"owner":"10877957","collectionId":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","publishedId":"2s8YzXvzhW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-10-31T17:19:15.000Z"},"item":[{"name":"Account","item":[{"name":"/account","event":[{"listen":"test","script":{"id":"822e8086-1bab-478d-af93-7d0d16871152","exec":["pm.test(\"/account status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"/account schema is valid\", function () {"," var schema = {"," \"$schema\": \"http://json-schema.org/draft-04/schema#\","," \"type\": \"object\","," \"properties\": {"," \"id\": {"," \"type\": \"string\""," },"," \"name\": {"," \"type\": \"string\""," }"," },"," \"required\": ["," \"id\","," \"name\""," ]"," }",""," var payload = pm.response.json()"," pm.expect(tv4.validate(payload, schema)).to.be.true;","});"],"type":"text/javascript"}}],"id":"0be820c3-c1a2-4128-ad59-8267e9e8b818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":false},"method":"GET","header":[],"url":"{base_url}/account","description":"

PARAMS

None

RESPONSE

Returns the account object.

\n","urlObject":{"path":["account"],"host":["{base_url}"],"query":[],"variable":[]}},"response":[{"id":"63c40797-30fb-45c8-bc38-0b6a868885ff","name":"/account 200","originalRequest":{"method":"GET","header":[],"url":"{base_url}/account"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3017\",\n \"name\": \"Demo Beyond Pricing Partner!\"\n}"}],"_postman_id":"0be820c3-c1a2-4128-ad59-8267e9e8b818"}],"id":"60b5dc2b-a33c-481c-b099-5d46b2ba5130","description":"

ATTRIBUTES

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
id	string	required	Unique ID of the account
name	string	required	Name to display to help a user identify his account

","event":[{"listen":"prerequest","script":{"id":"69b73244-b4ab-47a1-b8a6-9d89ed6213ba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0db401c4-e23c-4119-8b16-11860208f342","type":"text/javascript","exec":[""]}}],"_postman_id":"60b5dc2b-a33c-481c-b099-5d46b2ba5130","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}}},{"name":"Listing","item":[{"name":"/listings","id":"2bfc0915-4135-4b54-a261-41de99e9c5f8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[],"url":"{base_url}/listings","description":"

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
parentIdsFirst	boolean	optional	NEW (Effective Date: 2025-03-01): For multi-unit, Parent-Child structure usecase. Default to True. If not sent or False should sort by newly created listings.

RESPONSE

Returns array of all listing ids.

Sort listings by newly created listings first.

NEW (Effective Date: 2025-03-01): For multi-unit, Parent-Child structure usecase, if parentIdsFirst param is sent sort by Parent listings ids first.

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
listingId	string	required

RESPONSE

Returns the listing with Status code 200

Returns an error message with Status code 404 if the property listing is not found

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}},"urlObject":{"path":["listings","1000"],"host":["{base_url}"],"query":[],"variable":[]}},"response":[{"id":"e8417f9e-f07b-45bc-a25e-8d68661b128d","name":"/listings/1000 200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"url":"https://eeba6af4-2577-4dfc-9f37-67ff4a0abdc8.mock.pstmn.io/listings/1000 "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1000\",\n \"accountId\": \"3017\",\n \"createdAt\": \"2018-09-11T16:45:18Z\",\n \"updatedAt\": \"2018-09-11T16:45:18Z\",\n \"title\": \"Beatiful cabin in the woods\",\n \"url\": \"https://pms_domain.com/beatiful_cabin\",\n \"bedrooms\": 1,\n \"bathrooms\": 1,\n \"occupancy\": 4,\n \"occupancyPet\": 0,\n \"minNights\": 4,\n \"imageUrl\": \"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\",\n \"images\": [\"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\"],\n \"description\": \"Have Fun in this incredible Cabin\",\n \"isListed\": true,\n \"currency\": \"USD\",\n \"checkinDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"roomType\": \"just room\",\n \"phone\": \"+11 111-111-1111\",\n \"address\": {\n \"street\": \"135 4th St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zipCode\": \"94103\",\n \"latitude\": \"37.7843318\",\n \"longitude\": \"-122.4033663\"\n },\n \"amenities\": [\n \"wifi\",\n \"cable tv\",\n \"hot tub\",\n \"cold plunge\"\n ],\n \"parentId\": null,\n \"childUnitIds\": []\n}"},{"id":"a34fbcbb-a0c1-4d2d-8879-96ac96fc989d","name":"/listings/900 200 parentListing example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"url":"https://eeba6af4-2577-4dfc-9f37-67ff4a0abdc8.mock.pstmn.io/listings/900"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"900\",\n \"accountId\": \"3017\",\n \"createdAt\": \"2018-09-11T16:45:18Z\",\n \"updatedAt\": \"2018-09-11T16:45:18Z\",\n \"title\": \"Beatiful apt. in the city\",\n \"url\": \"https://pms_domain.com/beatiful_apt\",\n \"bedrooms\": 1,\n \"bathrooms\": 1,\n \"occupancy\": 4,\n \"occupancyPet\": 0,\n \"minNights\": 4,\n \"imageUrl\": \"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\",\n \"images\": [\"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\"],\n \"description\": \"Have Fun in this incredible apt\",\n \"isListed\": true,\n \"currency\": \"USD\",\n \"checkinDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"roomType\": \"just room\",\n \"phone\": \"+11 111-111-1111\",\n \"address\": {\n \"street\": \"135 4th St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zipCode\": \"94103\",\n \"latitude\": \"37.7843318\",\n \"longitude\": \"-122.4033663\"\n },\n \"amenities\": [\n \"wifi\",\n \"cable tv\",\n \"hot tub\",\n \"cold plunge\"\n ],\n \"parentId\": null,\n \"childUnitIds\": [\"901\", \"902\", \"903\"]\n}"},{"id":"8714db22-be50-451f-a794-0d67bccdac62","name":"/listings/901 200 childListing example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"url":"https://eeba6af4-2577-4dfc-9f37-67ff4a0abdc8.mock.pstmn.io/listings/901"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"901\",\n \"accountId\": \"3017\",\n \"createdAt\": \"2018-09-11T16:45:18Z\",\n \"updatedAt\": \"2018-09-11T16:45:18Z\",\n \"title\": \"Beatiful apt in the city - Apt. 01\",\n \"url\": \"https://pms_domain.com/beatiful_apt01\",\n \"bedrooms\": 1,\n \"bathrooms\": 1,\n \"occupancy\": 4,\n \"occupancyPet\": 0,\n \"minNights\": 4,\n \"imageUrl\": \"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\",\n \"images\": [\"https://i.picsum.photos/id/308/200/200.jpg?hmac=gCyOH3yDZDvlNeCodWo0et9Vw3peGSCuMsQBRNqgHJQ\"],\n \"description\": \"Have Fun in this incredible apt\",\n \"isListed\": true,\n \"currency\": \"USD\",\n \"checkinDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"friday\",\n \"saturday\"\n ],\n \"roomType\": \"just room\",\n \"phone\": \"+11 111-111-1111\",\n \"address\": {\n \"street\": \"135 4th St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zipCode\": \"94103\",\n \"latitude\": \"37.7843318\",\n \"longitude\": \"-122.4033663\"\n },\n \"amenities\": [\n \"wifi\",\n \"cable tv\",\n \"hot tub\",\n \"cold plunge\"\n ],\n \"parentId\": \"900\",\n \"childUnitIds\": []\n}"},{"id":"7933cf40-02e5-495a-b319-d90f6b1b786b","name":"/listings/invalid-id 404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json","disabled":true}],"url":"{base_url}/listings/invalid-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Listing with id:invalid-id does not exist\"\n}"}],"_postman_id":"e6e2aef6-2d78-4d07-b437-59766c83a7fb"},{"name":"/listings/{id}/calendar","id":"c11d96b9-3bd9-41c1-aa7f-1013664c410c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{base_url}/listings/1000/calendar","description":"

Fetch the calendar of a listing.

NEW (Effective Date: 2025-03-01): For multi-unit, Parent-Child structure usecase, Parent listings do not return any availability data, ie, just send an empty list. See examples. Calendars should come at the Child listing level.

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
listingId	string	required

RESPONSE

Returns an array of objects with daily prices, min nights, availability, check-in days, and check-out days.

AVAILABILITY ATTRIBUTE

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	Options	Description
availability	string	available, booked, blocked
date	string		ISO datetime format with time zone
dailyPrice	positive integer
minStays	positive integer
checkinDays	An array of strings.	sunday, monday, tuesday, wednesday thursday, friday, saturday	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
checkoutDays	An array of strings	sunday, monday, tuesday, wednesday thursday, friday, saturday	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
extraGuests	positive integer	Optional	Number of extra guests for which a fee is levied in extraGuestFees
extraGuestFee	positive integer	Optional	Fees paid for each extra guest added in extraGuests

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}},"urlObject":{"path":["listings","1000","calendar"],"host":["{base_url}"],"query":[],"variable":[]}},"response":[{"id":"4eefe73a-5c2a-4a73-9010-1f72d6e4885e","name":"/listings/1000/calendar 200","originalRequest":{"method":"GET","header":[],"url":"{base_url}/listings/1000/calendar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" [\n {\n \"date\": \"2019-06-26\",\n \"dailyPrice\": 296,\n \"availability\": \"booked\",\n \"minNights\": 3,\n \"checkinDays\": [\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"saturday\"\n ]\n },\n {\n \"date\": \"2019-06-27\",\n \"dailyPrice\": 296,\n \"availability\": \"available\",\n \"minNights\": 3,\n \"checkinDays\": [\n \"saturday\",\n \"friday\"\n ],\n \"checkoutDays\": [\n \"saturday\"\n ]\n },\n {\n \"date\": \"2019-06-28\",\n \"dailyPrice\": 433,\n \"availability\": \"available\",\n \"minNights\": 2,\n \"checkinDays\": [\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n },\n {\n \"date\": \"2019-06-29\",\n \"dailyPrice\": 433,\n \"availability\": \"available\",\n \"minNights\": 1,\n \"checkinDays\": [\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"saturday\"\n ]\n },\n {\n \"date\": \"2019-06-30\",\n \"dailyPrice\": 433,\n \"availability\": \"blocked\",\n \"minNights\": 1,\n \"checkinDays\": [\n \"saturday\"\n ],\n \"checkoutDays\": [\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n }\n ]"},{"id":"d745c149-5065-4b21-9c43-5b21387ea0f3","name":"/listings/900/calendar 200 Example parent listing","originalRequest":{"method":"GET","header":[],"url":"{base_url}/listings/900/calendar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" []"},{"id":"2b10209c-9d68-46a9-8a66-78a01244dcb1","name":"/listings/invalid-id/calendar 404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json","disabled":true}],"url":"{base_url}/listings/invalid-id/calendar"},"code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Listing with id:invalid-id does not exist\"\n}"}],"_postman_id":"c11d96b9-3bd9-41c1-aa7f-1013664c410c"},{"name":"/listings/{id}/calendar","id":"31bf272a-23d5-46ce-913d-53b9d6511cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"date\": \"2019-06-26\",\n \"dailyPrice\": \"296\",\n \"minNights\": 3,\n \"checkInDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"checkOutDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n },\n {\n \"date\": \"2019-06-27\",\n \"dailyPrice\": \"296\",\n \"minNights\": 3,\n \"checkInDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"checkOutDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n },\n {\n \"date\": \"2019-06-28\",\n \"dailyPrice\": \"433\",\n \"minNights\": 2,\n \"checkInDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"checkOutDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n },\n {\n \"date\": \"2019-06-29\",\n \"dailyPrice\": \"433\",\n \"minNights\": 1,\n \"checkInDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"checkOutDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n },\n {\n \"date\": \"2019-06-30\",\n \"dailyPrice\": \"433\",\n \"minNights\": 1,\n \"checkInDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"checkOutDays\": [\n \"sunday\",\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\"\n ],\n \"extraGuests\": 2,\n \"extraGuestFee\": 156\n }\n]"},"url":"{base_url}/listings/1000/calendar","description":"

Post daily prices, min nights, check-in and check-out days, extra guests, and guest fees for a listing.

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
listingId	string	required

BODY

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
date	string	required	ISO date format
dailyPrice	positive integer	required
minNights	positive integer	required	It defaults to 1
checkinDays	array	optional	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
checkoutDays	array	optional	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
extraGuests	positive integer	optional	Number of extra guests for which a fee is levied in extraGuestFees
extraGuestFee	positive integer	optional	Fees paid for each extra guest added in extraGuests

RESPONSE

Status code 200

ATTRIBUTES

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Sub Key	Type	Is required	Description
id		string	required	Unique ID of the listing
accountId		string	required	ID of the account
createdAt		string	required	ISO datetime format with time zone
updatedAt		string	required	ISO datetime format with time zone
title		string	required	Title of the listing
url		string	optional	Public PMS URL of the listing
parentListingId		string	optional	The id of the master listing for the multi-untis parent/child model
bedrooms		positive integer	required	Number of bedrooms
bathrooms		positive integer	required	Number of bathrooms
occupancy		positive integer	optional	Maximum occupancy
occupancyPet		positive integer	optional	Maximum pet occupancy
minNights		positive integer	required	Default minimum nights for the listing if implemented on PMS otherwise minimum nights specified in calendar
imageUrl		string	required	Main picture of the listing. URI format.
images		array	required	Array of strings with the images urls.
description		string	required	Listing description.
isListed		bool	required	Whether a listing is active and listed
currency		string	required	Currency of the listings, in which the prices will be
checkinDays		array	optional	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
checkoutDays		array	optional	Array of strings of names of days of the week. i.e sunday, monday, tuesday, wednesday thursday, friday, saturday.
phone		string	optional	Phone number for the property
address		object		Address for the property
	street	string	required
	city	string	required
	state	string	required
	zipCode	string	required
	country	string	required
	latitude	string	required
	longitude	string	required
roomType		string	required	The type of the room
amenities		array	optional	Array of string representing amenities. There is no reference list as Beyond AI will automatically normalize them to our internal mapping
parentId		string	optional	NEW (Effective Date: 2025-03-01): For multi-unit, Parent-Child structure usecase. Fill in if the listing is a Child unit. If present, should be the ID string of the Parent listing.
childUnitIds		array	optional	NEW (Effective Date: 2025-03-01): For multi-unit, Parent-Child structure usecase. Fill in if the listing is a Parent listing. Array of string representing the Child unit IDs.

","event":[{"listen":"prerequest","script":{"id":"dada34ae-b43f-4a02-a447-c0db202aeff7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94e90087-0485-4730-9a8c-c33de72503cf","type":"text/javascript","exec":[""]}}],"_postman_id":"80559bae-af6e-4e92-a4bd-0b2930f3783a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}}},{"name":"Reservation","item":[{"name":"/listings/{id}/reservations","id":"9536d3f9-0207-429f-9e7f-46c3547d768e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{base_url}/listings/1000/reservations?checkoutStartDate=2019-04-01&checkinStartDate=2019-05-01","description":"

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
checkoutStartDate	string	optional - preferred	ISO date format
checkinStartDate	string	optional	ISO date format

RESPONSE

Returns array of reservations that have the checkout date greater or equal than checkoutStartDate. If checkinStartDate is passed it should also return reservations that have checkin date greater or equal than checkoutStartDate.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}},"urlObject":{"path":["listings","1000","reservations"],"host":["{base_url}"],"query":[{"key":"checkoutStartDate","value":"2019-04-01"},{"key":"checkinStartDate","value":"2019-05-01"}],"variable":[]}},"response":[{"id":"dd24a27e-9e22-42ca-ab50-ef7f416eae6e","name":"/listings/1000/reservations 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{base_url}/listings/1000/reservations?checkinStartDate=2019-05-01&checkoutStartDate=2019-04-01","host":["{base_url}"],"path":["listings","1000","reservations"],"query":[{"key":"checkinStartDate","value":"2019-05-01"},{"key":"checkoutStartDate","value":"2019-04-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1001\",\n \"listingId\": \"1000\",\n \"bookedAt\": \"2019-02-01T16:45:18.359126-06:00\",\n \"checkinDate\": \"2019-05-27\",\n \"checkoutDate\": \"2019-06-02\",\n \"amount\": 1485,\n \"cleaningFeeAmount\": 300,\n \"taxes\": 100,\n \"rentalAmount\": 1885,\n \"status\": \"accepted\",\n \"isOwner\": false,\n \"currency\": \"USD\",\n \"guest\": {\n \"id\": \"100\",\n \"firstName\": \"David\",\n \"lastName\": \"Kelso\",\n \"email\": \"integrations@beyondpricing.com\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"phoneNumber\": \"415-200-0295\"\n },\n \"adults\": 2,\n \"children\": 2,\n \"source\": \"airbnb\"\n },\n {\n \"id\": \"12345690\",\n \"listingId\": \"10000\",\n \"bookedAt\": \"2019-02-24T16:45:18.359126-06:00\",\n \"checkinDate\": \"2019-08-07\",\n \"checkoutDate\": \"2019-08-11\",\n \"amount\": 0,\n \"cleaningFeeAmount\": 0,\n \"taxes\": 0,\n \"rentalAmount\": 0,\n \"status\": \"accepted\",\n \"isOwner\": true,\n \"currency\": \"USD\",\n \"guest\": {\n \"id\": \"101\",\n \"firstName\": \"Or\"\n },\n \"adults\": 2,\n \"children\": 0,\n \"source\": \"homeaway\"\n },\n {\n \"id\": \"12345692\",\n \"listingId\": \"10000\",\n \"bookedAt\": \"2019-03-24T16:45:18.359126-06:00\",\n \"checkinDate\": \"2019-09-07\",\n \"checkoutDate\": \"2019-09-11\",\n \"amount\": 1200,\n \"cleaningFeeAmount\": 300,\n \"taxes\": 90,\n \"rentalAmount\": 1590,\n \"status\": \"canceled\",\n \"isOwner\": false,\n \"currency\": \"USD\",\n \"guest\": {\n \"id\": \"102\",\n \"firstName\": \"Michael\",\n \"lastName\": \"Palumbo\",\n \"email\": \"michaelisawesome@beyondpricing.com\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"phoneNumber\": \"415-200-0297\"\n },\n \"adults\": 2,\n \"children\": 1,\n \"source\": \"booking.com\"\n },\n {\n \"id\": \"12345693\",\n \"listingId\": \"10000\",\n \"bookedAt\": \"2019-03-25T16:45:18.359126-06:00\",\n \"checkinDate\": \"2019-03-01\",\n \"checkoutDate\": \"2019-06-01\",\n \"amount\": 12000,\n \"cleaningFeeAmount\": 300,\n \"taxes\": 180,\n \"rentalAmount\": 15990,\n \"status\": \"canceled\",\n \"isOwner\": true,\n \"currency\": \"USD\",\n \"guest\": {\n \"id\": \"101\",\n \"firstName\": \"Luis\",\n \"lastName\": \"Conde\",\n \"email\": \"luisisawesome@beyondpricing.com\",\n \"city\": \"Lisbon\",\n \"state\": \"\",\n \"country\": \"PT\",\n \"phoneNumber\": \"00351-919191911\"\n },\n \"adults\": 2,\n \"children\": 2,\n \"source\": \"VRBO\"\n }\n]"},{"id":"a02751f2-00bf-4ba6-9b2d-e739f203914a","name":"/listings/invalid-id/reservations 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"{base_url}/listings/invalid-id/reservations?checkinStartDate=2019-05-01","host":["{base_url}"],"path":["listings","invalid-id","reservations"],"query":[{"key":"checkinStartDate","value":"2019-05-01"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Listing with id:invalid-id does not exist\"\n}"}],"_postman_id":"9536d3f9-0207-429f-9e7f-46c3547d768e"},{"name":"/reservations/{id}","id":"3d89b2f7-b648-4f61-a554-81be64681278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{base_url}/reservations/1001","description":"

PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Is required	Description
reservationId	string	required

RESPONSE

Returns reservation.

\n
Note: Whatever the status of the reservations (booked, canceled, etc.), the format must be the same as that of a reservation, with all the required fields.
\n

ATTRIBUTES

Key	sub key	Type	Is required	Description
id		string	required	Unique ID of the reservation
listingId		string	required
bookedAt		string	required	ISO datetime format with timezone
canceledAt		string	required	ISO datetime format with timezone or an empty String
checkinDate		string	required	ISO date format
checkoutDate		string	required	ISO date format
status		string	required	Options: accepted, canceled, unconfirmed
currency		string	required	Currency of the amounts - ISO 4217 format
isOwner		boolean	required	Whether it is an owner booking. It defaults to False
adults		positive integer	required	number of adults
children		positive integer	required	number of children
source		string	required	The channel where the reservation was made. Eg. \"airbnb\", \"homeaway\", \"booking.com
amount		positive decimal	required	Rental amount excluding taxes and fees
cleaningFeeAmount		positive decimal	required	Fees for cleaning
taxes		positive decimal	required	Taxes
rentalAmount		positive decimal	required	Total amount with all fees including taxes
guest		object	required	JSON Object with guest info
	id	string	required
	firstName	string	optional
	lastName	string	optional
	phoneNumber	string	optional
	email	string	optional
	city	string	optional
	state	string	optional
	country	string	optional

","event":[{"listen":"prerequest","script":{"id":"8ee1dd67-3f73-47e6-874f-6e7facb57cdb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6c12f861-3913-4f70-b5ed-18c1ec5a27d2","type":"text/javascript","exec":[""]}}],"_postman_id":"7b21446d-04b1-4c62-93da-4d2898534c95","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]},"isInherited":true,"source":{"_postman_id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","id":"6a4c3f08-39e6-4eb4-8c37-b0b79932c890","name":"Dynamic Integration API Reference","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96"}]}},"event":[{"listen":"prerequest","script":{"id":"4c119341-8ad4-413e-9535-e0524341fbfc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c467388c-9ff3-4fe0-adfd-41053014d71a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"valid-api-key","value":"PMAK-63b599871ede74346630017e-a73dfa37764fe16b91993c921c18645d96","type":"string"},{"key":"url","value":"{base_url}","type":"string"}]}