{"info":{"_postman_id":"e8848216-1037-49e3-9c49-78a91353162c","name":"BEONx API","description":"

Getting Started

Before using the BEONx API, you'll need the following:

A user and password at BEONx.
Access to one or more resources. Different API requests may require elevated privileges.
A network connection to api.beonprice.com.

\n
If you're missing any of these requirements, please contact BEONx via email.
\n

Postman

You can run this API in your own Postman local environment.

BEONx Terminology

To understand this API, let's clarify some key terms and their meanings at BEONx.

Contract: Every establishment with access to BEONx is referred to as a contract. Normally, a contract includes the main property plus zero to N competitor properties. Most requests in our APIs require the identifier of the contract at BEONx.
\n
Company: is equivalent to a hotel chain. A company includes a number of contracts that belong to a same BEONx client.
\n
Cluster: A cluster is a set of contracts from the same company with shared attributes. Users can create as many clusters as needed based on factors such as geolocation, star ratings, etc.
\n
Space: A space represents rooms or physical spaces within a property with shared characteristics. Nowadays, it is related to room type or category, for example: \"Double Queen Room with Sea View\".
\n
Rate Plan: A rate plan defines the pricing strategy for one or more spaces. It is defined by: meal plan, cancellation policy and conditions (release, MLOS, travel/booking dates, etc). Examples of rate plans include \"Best Available Rate\" or \"Breakfast Included Rate.\" There are three types of pricing configurations:
\n
- Dynamic pricing: Oriented to yieldable rates that can be priced dynamically based on demand, market conditions, historical data, and more.
- Indexed pricing: Yieldable rates whose pricing recommendations are generated based on supplements. BEONx can only optimize these rates through restriction recommendations (stop sell, MLOS, etc).
- Fixed pricing: This pricing strategy refers to non-yieldable rates such as corporate rates, negotiable rates, etc. All recommendations are restricted to specific conditions.
\n
Rate Codes: It is defined in BEONx as the combination of: space + occupancy + meal plan + rate plan. Examples include \"Double - 2-0 - Room Only - Best Available Rate\" or \"Junior Suite - 2-0 - Breakfast - Breakfast Included Rate.\" BEONx recommendations outputs are provided for each of rate code.
\n
Supplements: BEONx defined supplements as the discounts or surcharges such as meal prices, room category, etc. These can be set up by person or room.
\n
Exceptions: Due to the seasonality of hotels, BEONx allows to configure exceptions for Spaces, Supplements, and Rate Codes. This flexibility enables the system to adapt the pricing strategy to different seasons.
\n

If you have any specific questions or need further information about the BEONx API or the terms mentioned, please feel free to ask.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"30683382","collectionId":"e8848216-1037-49e3-9c49-78a91353162c","publishedId":"2s9YRFU9dP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"E30D95"},"publishDate":"2023-10-26T09:37:36.000Z"},"item":[{"name":"Auth","item":[{"name":"User Login","id":"f591ab9f-9b7b-442e-ba2e-e7d1ab519880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{user}}","type":"text","description":"

BEONx account email

\n"},{"key":"password","value":"{{password}}","type":"text","description":"

BEONx account password

\n"}]},"url":"https://api.beonprice.com/v2.4/auth/login","description":"

Generates the access token neccesary to use the API.

\n","urlObject":{"path":["v2.4","auth","login"],"host":["https://api.beonprice.com"],"query":[],"variable":[]}},"response":[{"id":"8ed418fe-77b6-457a-a687-417513155580","name":"200 - Token created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{user}}","type":"text","description":"BEONx account email"},{"key":"password","value":"{{password}}","type":"text","description":"BEONx account password"}]},"url":"https://api.beonprice.com/v2.4/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"generated-token\",\n \"validUntil\": \"2023-10-24T00:00:00+0000\"\n}"},{"id":"edec822e-76bd-4a3d-8cfb-34f9813f887f","name":"400 - Missing parameters","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{user}}","type":"text","description":"BEONx account email","disabled":true},{"key":"password","value":"{{password}}","type":"text","description":"BEONx account password"}]},"url":"https://api.beonprice.com/v2.4/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0002\",\n \"message\": \"Missing parameters\",\n \"moreInfo\": \"\"\n }\n}"},{"id":"f48c742b-3e9d-4933-8617-d8d5b9ac3a81","name":"401 - Wrong credentials","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{user}}","type":"text","description":"BEONx account email"},{"key":"password","value":"{{token}}","type":"text","description":"BEONx account password"}]},"url":"https://api.beonprice.com/v2.4/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0003\",\n \"message\": \"The credentials provided are invalid\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"f591ab9f-9b7b-442e-ba2e-e7d1ab519880"}],"id":"59ae7294-8cf3-4e2e-a837-6cd47bbea33c","description":"

To use any request in this API, you need to authenticate them with a token.

The User Login request, using your BEONx account email and password, will assist you in generating a new token. Please note that this token will expire after 1 hour. We recommend storing and reusing this token during the following 30 minutes.

A single user can only have 25 active tokens.

Configure Your Postman Environment

To streamline your workflow, you can configure a few global or environment variables with your own values. This way, you can use all the requests without manual editing or setup.

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

Variable	Description
user	BEONx user email
password	BEONx user password
token	Authorization token generated in the login request
contractId	ID of the BEONx contract used during testing

","_postman_id":"59ae7294-8cf3-4e2e-a837-6cd47bbea33c"},{"name":"Inventory Configuration","item":[{"name":"Get spaces","id":"e80c6b2e-77aa-481f-b5ff-921b32e22b77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"

Token provided in the login request.

\n","type":"text"},{"key":"username","value":"{{user}}","description":"

Email associated with the user account.

\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces","description":"

Use this request to retrieve information about the spaces configured in BEONx.

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

Parameter	Description	Required	Values
category	Space category type	No	room, apartment
created_from	Filter spaces created after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`
updated_from	Filter spaces updated after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`

","urlObject":{"path":["v2.4","configuration","{{contractId}}","spaces"],"host":["https://api.beonprice.com"],"query":[{"disabled":true,"key":"category","value":"room"},{"disabled":true,"key":"created_from","value":"2021-09-14T00:00:00.000000Z"},{"disabled":true,"key":"updated_from","value":"2023-07-04T13:31:24.217000Z"}],"variable":[]}},"response":[{"id":"26ecf04a-dddf-4dd2-a72b-78b5f69e1a7f","name":"200 - Get spaces","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"spaces\": [\n {\n \"_id\": \"6538cd9238d53579cad3e34d\",\n \"contract_id\": \"6538cd403b9b37ac3ed0c7fe\",\n \"comparative_id\": \"6538cd5a50a92b2bb9f1b539\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [\n \"6538cd6192709e437e036f89\"\n ],\n \"name\": \"Doble\",\n \"code\": \"55196\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 38,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Doble\",\n \"Petit\"\n ],\n \"pms_physical_room_mappings\": [\n \"DOBL\",\n \"SMALL\"\n ],\n \"order\": 1,\n \"overbooking\": 5,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55196\",\n \"endpoint_id\": \"6538cd6cbae39dd04dc6b015\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538cd7a986c1230e3f8f1f4\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538cd7f9f0ec6a5e496a457\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:04.106000Z\",\n \"created_at\": \"2021-09-14T12:52:01.449000Z\"\n },\n {\n \"_id\": \"6538cd8a9af59c70362df62b\",\n \"contract_id\": \"6538cda49deae78ba4e20279\",\n \"comparative_id\": \"6538cda95ba2f4195678fbc4\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Smallsa SOLO ENVÍO\",\n \"code\": \"55195\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 0,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"smallsa\"\n ],\n \"pms_physical_room_mappings\": [\n \"SMALLSA\"\n ],\n \"order\": 2,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55195\",\n \"endpoint_id\": \"6538cdb4caaa3b41cc8a3a2e\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538cdb8ce5868ebea0beb10\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538cdbcb40d90aa9041db7e\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:31.957000Z\",\n \"created_at\": \"2021-09-14T12:52:01.458000Z\"\n }\n ]\n}"},{"id":"50301f3a-8bdc-41b3-b365-dd1e73663106","name":"200 - Get spaces by category","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"category\": \"room\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces?category=room","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","spaces"],"query":[{"key":"category","value":"room"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"spaces\": [\n {\n \"_id\": \"6538cdd4b739fd8af334059e\",\n \"contract_id\": \"6538cddb3d3bb4a6028b4696\",\n \"comparative_id\": \"6538cde185618b83e34ac9f5\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [\n \"6538cde7272b8882cc95a2aa\"\n ],\n \"name\": \"Doble\",\n \"code\": \"55196\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 38,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Doble\",\n \"Petit\"\n ],\n \"pms_physical_room_mappings\": [\n \"DOBL\",\n \"SMALL\"\n ],\n \"order\": 1,\n \"overbooking\": 5,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55196\",\n \"endpoint_id\": \"6538cded6f5a62e6d564300b\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538cdf1fad499dd3f91f9c4\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538cdf518a0f9fbc146ae9b\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:04.106000Z\",\n \"created_at\": \"2021-09-14T12:52:01.449000Z\"\n },\n {\n \"_id\": \"6538cdfcbab9572b39b8db83\",\n \"contract_id\": \"6538ce00345a229375896e9f\",\n \"comparative_id\": \"6538ce0439ce64087c610a0c\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Smallsa SOLO ENVÍO\",\n \"code\": \"55195\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 0,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"smallsa\"\n ],\n \"pms_physical_room_mappings\": [\n \"SMALLSA\"\n ],\n \"order\": 2,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55195\",\n \"endpoint_id\": \"6538ce08178cabb19ff00cff\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538ce1087d2bfb29f23e2d9\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538ce149d18e9c7df6137bd\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:31.957000Z\",\n \"created_at\": \"2021-09-14T12:52:01.458000Z\"\n },\n {\n \"_id\": \"6538ce1db18e8baf896c6e7d\",\n \"contract_id\": \"6538ce25b519ed6d4618ff14\",\n \"comparative_id\": \"6538ce2a5d99a81b92632ada\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Doble Superior\",\n \"code\": \"55198\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 4,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Doble Superior\"\n ],\n \"pms_physical_room_mappings\": [\n \"DBSP\"\n ],\n \"order\": 3,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55198\",\n \"endpoint_id\": \"6538ce2f1413b90dc339eaa1\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538ce38b96df2aa83d87319\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538ce3eb0523ce6fc008eca\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:30:34.532000Z\",\n \"created_at\": \"2021-09-14T12:52:01.467000Z\"\n }\n ]\n}"},{"id":"358170d4-6ada-4e45-93b5-163585fde9fc","name":"200 - Get spaces created from","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"created_from\": \"2021-09-14T00:00:00.000000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces?created_from=2021-09-14T00:00:00.000000Z","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","spaces"],"query":[{"key":"created_from","value":"2021-09-14T00:00:00.000000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"spaces\": [\n {\n \"_id\": \"6538ce4c05fef03aa816c1e3\",\n \"contract_id\": \"6538ce53d7e5eb555c45077b\",\n \"comparative_id\": \"6538ce594865708aaff0817c\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [\n \"6538ce5f6111c2edf4722060\"\n ],\n \"name\": \"Doble\",\n \"code\": \"55196\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 38,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Doble\",\n \"Petit\"\n ],\n \"pms_physical_room_mappings\": [\n \"DOBL\",\n \"SMALL\"\n ],\n \"order\": 1,\n \"overbooking\": 5,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55196\",\n \"endpoint_id\": \"6538ce6bba7358122510bc99\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538ce72db4ca8fb3708f8ba\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538ce7887b337ae10d3b919\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:04.106000Z\",\n \"created_at\": \"2021-09-14T12:52:01.449000Z\"\n },\n {\n \"_id\": \"6538ce9f6fa43c563f8cf3c1\",\n \"contract_id\": \"6538cea57c48f88eee9a3dab\",\n \"comparative_id\": \"6538cea9a3e281a37bafa4f9\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Smallsa SOLO ENVÍO\",\n \"code\": \"55195\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 0,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"smallsa\"\n ],\n \"pms_physical_room_mappings\": [\n \"SMALLSA\"\n ],\n \"order\": 2,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55195\",\n \"endpoint_id\": \"6538ceae8bec19946259f002\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538ceb6acd168262621c6e7\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538cebbc541d08bd7e34d48\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:27:31.957000Z\",\n \"created_at\": \"2021-09-14T12:52:01.458000Z\"\n },\n {\n \"_id\": \"6538cecce72c64d965643958\",\n \"contract_id\": \"6538ced19ff2277ffcf6dfd0\",\n \"comparative_id\": \"6538ced521a4e815bc81c2af\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Doble Superior\",\n \"code\": \"55198\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 4,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Doble Superior\"\n ],\n \"pms_physical_room_mappings\": [\n \"DBSP\"\n ],\n \"order\": 3,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55198\",\n \"endpoint_id\": \"6538cedfdca20fc352aa73ba\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538cee4ad347f69f11d51bc\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": 0,\n \"_id\": \"6538cee979bb3b4ae51fb775\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:30:34.532000Z\",\n \"created_at\": \"2021-09-14T12:52:01.467000Z\"\n }\n ]\n}"},{"id":"ad4abf6b-aec1-473a-948b-6cdfb00fa1a3","name":"200 - Get spaces updated from","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"updated_from\": \"2023-07-04T13:31:24.217000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces?updated_from=2023-07-04T13:31:24.217000Z","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","spaces"],"query":[{"key":"updated_from","value":"2023-07-04T13:31:24.217000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"spaces\": [\n {\n \"_id\": \"6538d09f0388408d76d87798\",\n \"contract_id\": \"6538d0ad0928ffadae973410\",\n \"comparative_id\": \"6538d0b1ad4f4ef59cb7a987\",\n \"parent_space_id\": null,\n \"overbooking_derivations_ids\": [],\n \"name\": \"Triple\",\n \"code\": \"55197\",\n \"category\": \"room\",\n \"min_occupancy\": {\n \"adults\": 3,\n \"children\": 0\n },\n \"max_occupancy\": {\n \"adults\": 3,\n \"children\": 0\n },\n \"reference_occupancy\": {\n \"adults\": 3,\n \"children\": 0\n },\n \"bedding\": null,\n \"sold_by_unit_bedding\": false,\n \"inventory_total\": 7,\n \"inventory_blocked\": 0,\n \"pms_mappings\": [\n \"Triple\"\n ],\n \"pms_physical_room_mappings\": [\n \"TRPL\"\n ],\n \"order\": 4,\n \"overbooking\": null,\n \"room_cost\": null,\n \"walk_cost\": null,\n \"endpoint_mappings\": [\n {\n \"code\": \"55197\",\n \"endpoint_id\": \"6538d0b934ddf27921005f39\",\n \"enabled\": true,\n \"capabilities\": [],\n \"safety_price_min\": null,\n \"safety_price_max\": null,\n \"_id\": \"6538d0be77f25b45c5ab3d56\"\n }\n ],\n \"occupancies\": [\n {\n \"adults\": 3,\n \"children\": 0,\n \"_id\": \"6538d0c3a35c8b61985ade63\"\n }\n ],\n \"updated_at\": \"2023-07-04T13:31:24.217000Z\",\n \"created_at\": \"2021-09-14T12:52:01.478000Z\"\n }\n ]\n}"},{"id":"b9c46f0f-e12c-46c5-862d-dd4964d0c637","name":"401 - Login needed","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/spaces/index"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0001\",\n \"message\": \"Login needed\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"e80c6b2e-77aa-481f-b5ff-921b32e22b77"},{"name":"Get supplements","id":"7449f6b4-3202-4f5e-8765-eb97546aed49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"

Token provided in the login request.

\n","type":"text"},{"key":"username","value":"{{user}}","description":"

Email associated with the user account.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements","description":"

Use this request to retrieve information about the supplements configured in BEONx.

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

Field	Description	Required	Values
type	Supplement type	No	space, extraPerson, mealPlan, cancellationPolicy, mLos, earlyBooking, lastMinute, negotiated, custom
created_from	Filter supplements created after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`
updated_from	Filter supplements updated after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`

","urlObject":{"path":["v2.4","configuration","{{contractId}}","supplements"],"host":["https://api.beonprice.com"],"query":[{"disabled":true,"key":"type","value":"space"},{"disabled":true,"key":"created_from","value":"2023-01-01T10:00:00.000000Z"},{"disabled":true,"key":"updated_from","value":"2023-01-01T10:00:00.000000Z"}],"variable":[]}},"response":[{"id":"6bc2f928-9ff8-4c2e-83f5-5d56918fa50c","name":"200 - Get supplements","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"supplements\": [\n {\n \"_id\": \"6538c3f41c070708c2026af6\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Breakfast\",\n \"apply_to\": \"total\",\n \"type\": \"mealPlan\",\n \"charged_by\": \"personNight\",\n \"order\": 0,\n \"values\": {\n \"type\": \"auto\",\n \"value\": 27,\n \"measure\": \"units\",\n \"sub_type\": \"breakfast\",\n \"children_type\": \"auto\",\n \"children_value\": 19,\n \"children_measure\": \"units\",\n \"meal_cost\": 0\n },\n \"updated_at\": \"2023-03-22T11:28:22.864000Z\",\n \"created_at\": \"2021-09-14T13:46:54.701000Z\"\n },\n {\n \"_id\": \"6538c4311c070708c2026af8\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Superior Room Extra adult\",\n \"apply_to\": \"base\",\n \"type\": \"extraPerson\",\n \"charged_by\": \"personNight\",\n \"order\": 1,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 70,\n \"measure\": \"units\",\n \"space_id\": \"6538d3533fb13d02e91981f2\",\n \"sub_type\": \"adult\"\n },\n \"updated_at\": \"2021-09-27T20:43:01.501000Z\",\n \"created_at\": \"2021-09-14T13:46:54.711000Z\"\n },\n {\n \"_id\": \"6538c5491c070708c2026af9\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Superior Jr Suite Extra adult\",\n \"apply_to\": \"base\",\n \"type\": \"extraPerson\",\n \"charged_by\": \"personNight\",\n \"order\": 1,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 70,\n \"measure\": \"units\",\n \"space_id\": \"6538d36d3fb13d02e91981f3\",\n \"sub_type\": \"adult\"\n },\n \"updated_at\": \"2021-09-27T20:43:01.510000Z\",\n \"created_at\": \"2021-09-14T13:46:54.715000Z\"\n }\n ]\n}"},{"id":"2de1a5d7-cadb-4053-8e12-f8c14559b450","name":"200 - Get supplements by type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","supplements"],"query":[{"key":"type","value":"space","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"supplements\": [\n {\n \"_id\": \"6538cf732c6d0f78d37e8153\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Superior Jr Suite\",\n \"apply_to\": \"base\",\n \"type\": \"space\",\n \"charged_by\": \"roomNight\",\n \"order\": 4,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 110,\n \"measure\": \"units\",\n \"space_id\": \"6538d3a73fb13d02e91981f4\",\n \"space_ref_id\": \"6538d3b43fb13d02e91981f5\",\n \"sub_type\": \"room\"\n },\n \"updated_at\": \"2023-02-08T08:58:55.598000Z\",\n \"created_at\": \"2021-09-14T13:46:54.785000Z\"\n },\n {\n \"_id\": \"6538cf7b2c6d0f78d37e8154\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Superior View Junior Suite\",\n \"apply_to\": \"base\",\n \"type\": \"space\",\n \"charged_by\": \"roomNight\",\n \"order\": 6,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 135,\n \"measure\": \"units\",\n \"space_id\": \"6538d3bc3fb13d02e91981f6\",\n \"space_ref_id\": \"6538d3c63fb13d02e91981f9\",\n \"sub_type\": \"room\"\n },\n \"updated_at\": \"2023-02-08T08:59:09.331000Z\",\n \"created_at\": \"2021-09-14T13:46:54.807000Z\"\n }\n ]\n}"},{"id":"14584724-6e5b-48c2-89a0-6e5b7f38a2ab","name":"200 - Get supplements created from","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"created_from\": \"2023-03-22T10:25:10.470000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","supplements"],"query":[{"key":"created_from","value":"2023-03-22T10:25:10.470000Z","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"supplements\": [\n {\n \"_id\": \"6538cf932c6d0f78d37e8155\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Classic\",\n \"apply_to\": \"base\",\n \"type\": \"custom\",\n \"charged_by\": \"personNight\",\n \"order\": 31,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 195,\n \"measure\": \"units\",\n \"children_type\": \"increase\",\n \"children_value\": 195,\n \"children_measure\": \"units\",\n \"sub_type\": null\n },\n \"updated_at\": \"2023-03-22T11:25:09.470000Z\",\n \"created_at\": \"2023-03-22T11:25:09.470000Z\"\n },\n {\n \"_id\": \"6538cf932c6d0f78d37e8155\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Minibar\",\n \"apply_to\": \"base\",\n \"type\": \"custom\",\n \"charged_by\": \"stay\",\n \"order\": 32,\n \"values\": {\n \"type\": \"increase\",\n \"value\": 1,\n \"measure\": \"units\",\n \"children_type\": null,\n \"children_value\": null,\n \"children_measure\": null,\n \"sub_type\": null\n },\n \"updated_at\": \"2023-03-22T11:26:28.154000Z\",\n \"created_at\": \"2023-03-22T11:26:28.154000Z\"\n }\n ]\n}"},{"id":"8be3b871-edce-44b0-8f99-46c6100935a8","name":"200 - Get supplements updated from","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","supplements"],"query":[{"key":"updated_from","value":"2023-03-22T11:28:22.864000Z","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"supplements\": [\n {\n \"_id\": \"6538cfa62c6d0f78d37e8156\",\n \"contract_id\": \"6538c4071c070708c2026af7\",\n \"name\": \"Breakfast\",\n \"apply_to\": \"total\",\n \"type\": \"mealPlan\",\n \"charged_by\": \"personNight\",\n \"order\": 0,\n \"values\": {\n \"type\": \"auto\",\n \"value\": 27,\n \"measure\": \"units\",\n \"sub_type\": \"breakfast\",\n \"children_type\": \"auto\",\n \"children_value\": 19,\n \"children_measure\": \"units\",\n \"meal_cost\": 0\n },\n \"updated_at\": \"2023-03-22T11:28:22.864000Z\",\n \"created_at\": \"2021-09-14T13:46:54.701000Z\"\n }\n ]\n}"},{"id":"930a1e66-a207-4c1e-93fc-3ae917c6ce6a","name":"401 - Login needed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"space\",\n \"created_from\": \"2023-01-01T10:00:00.000000Z\",\n \"updated_from\": \"2023-01-01T10:00:00.000000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/supplements/index"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0001\",\n \"message\": \"Login needed\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"7449f6b4-3202-4f5e-8765-eb97546aed49"},{"name":"Get rate plans","id":"35318f2d-30aa-4de3-a4b8-f2e47b8bf2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"

Token provided in the login request.

\n","type":"text"},{"key":"username","value":"{{user}}","description":"

Email associated with the user account.

\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"created_from\": \"2023-01-01T10:00:00.000000Z\",\n \"updated_from\": \"2023-01-01T10:00:00.000000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans","description":"

Use this request to retrieve information about the Rate Plans configured in BEONx.

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

Field	Description	Required	Values
created_from	Filter Rate Plans created after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`
updated_from	Filter Rate Plans updated after a specified date in ISO-8601 format.	No	Example: `2023-10-26T08:52:22Z`

","urlObject":{"path":["v2.4","configuration","{{contractId}}","ratePlans"],"host":["https://api.beonprice.com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"c6a9c10e-20a2-4240-961a-849ceb4c4324","name":"200 - Get rate plans","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request."},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans","protocol":"https","host":["api","beonprice","com"],"path":["v2.4","configuration","{{contractId}}","ratePlans"],"query":[{"key":"created_from","value":"2023-08-03T10:00:00.000000Z","type":"text","disabled":true},{"key":"updated_from","value":"2023-08-23T12:15:00.000000Z","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plans\": [\n {\n \"_id\": \"6538d0f283904f933d042728\",\n \"name\": \"Best Available Rate\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\"free\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [\n {\n \"date_start\": \"2023-08-03T00:00:00.000000Z\",\n \"date_end\": \"2027-12-31T00:00:00.000000Z\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"BAR\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"5b35ff7409fea47ac739e37d\",\n \"5b35ff7409fea47ac739e37f\",\n \"5b35ff7409fea47ac739e380\",\n \"5b35ff7409fea47ac739e381\",\n \"5b35ff7409fea47ac739e385\",\n \"5b35ff7409fea47ac739e386\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-03T07:30:18.226000Z\",\n \"created_at\": \"2023-08-03T07:30:18.226000Z\"\n },\n {\n \"_id\": \"6538d100b096acd0a990506e\",\n \"name\": \"Continental Breakfast\",\n \"meal_plan\": [\n \"breakfast\"\n ],\n \"cancel_charge\": [\"special\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"BRKF\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6538d105a906744de7a2cd9e\",\n \"supplement_ids\": [\n \"6538d10e075b667c6a6cdde6\"\n ],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"6538d114f6f2a4ad3e1266ab\",\n \"6538d11a6f8cbd7403fd5c82\",\n \"6538d12095f3c3997e16d7a7\",\n \"6538d125ee049a09f4eaf80a\",\n \"6538d1299b1ac71f2025df59\",\n \"6538d12d9f17c3477220ac9d\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-23T12:13:49.444000Z\",\n \"created_at\": \"2023-08-23T12:10:46.241000Z\"\n },\n {\n \"_id\": \"6538d13be68f968e6ea3ed73\",\n \"name\": \"Direct\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\"no\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"DIR\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6538d141b64fb34de7012623\",\n \"supplement_ids\": [],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"6538d148251c839d284e4d3e\",\n \"6538d14de58caea334c1a78d\",\n \"6538d157a171188d75092f12\",\n \"6538d15fa202483e3a67fde3\",\n \"6538d1637d8721381c300b1b\",\n \"6538d167c2cb31a07e5329c3\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-23T12:15:04.558000Z\",\n \"created_at\": \"2023-08-23T12:15:04.558000Z\"\n }\n ]\n}"},{"id":"9633a59e-b618-4d2f-aba1-539edb1eba5b","name":"200 - Get rate plans created from","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request."},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans?created_from=2023-08-03T10:00:00.000000Z","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","ratePlans"],"query":[{"key":"created_from","value":"2023-08-03T10:00:00.000000Z","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plans\": [\n {\n \"_id\": \"6538d17f81298b8119df30c5\",\n \"name\": \"Continental Breakfast\",\n \"meal_plan\": [\n \"breakfast\"\n ],\n \"cancel_charge\": [\"special\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"BRKF\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6538d19a94b936a61a60bbec\",\n \"supplement_ids\": [\n \"6538d18aafe54e4931ef609c\"\n ],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"6538d148251c839d284e4d3e\",\n \"6538d14de58caea334c1a78d\",\n \"6538d157a171188d75092f12\",\n \"6538d15fa202483e3a67fde3\",\n \"6538d1637d8721381c300b1b\",\n \"6538d167c2cb31a07e5329c3\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-23T12:13:49.444000Z\",\n \"created_at\": \"2023-08-23T12:10:46.241000Z\"\n },\n {\n \"_id\": \"6538d1b5a49ebbc2879c6309\",\n \"name\": \"Direct\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\"free\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"DIR\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6538d1bab361371ecf3fc124\",\n \"supplement_ids\": [],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"6538d148251c839d284e4d3e\",\n \"6538d14de58caea334c1a78d\",\n \"6538d157a171188d75092f12\",\n \"6538d15fa202483e3a67fde3\",\n \"6538d1637d8721381c300b1b\",\n \"6538d167c2cb31a07e5329c3\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-23T12:15:04.558000Z\",\n \"created_at\": \"2023-08-23T12:15:04.558000Z\"\n }\n ]\n}"},{"id":"93eca6b1-58c2-4a6c-a010-ea312ab68bb1","name":"200 - Get rate plans updated from","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request."},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/index?updated_from=2023-08-23T12:15:00.000000Z","host":["https://api.beonprice.com"],"path":["v2.4","configuration","{{contractId}}","ratePlans","index"],"query":[{"key":"updated_from","value":"2023-08-23T12:15:00.000000Z","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plans\": [\n {\n \"_id\": \"6538d1ddc0691d3a879e1027\",\n \"name\": \"Direct\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\"free\"],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"DIR\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6538d1e32d05ccebf09dfa64\",\n \"supplement_ids\": [],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"6538d148251c839d284e4d3e\",\n \"6538d14de58caea334c1a78d\",\n \"6538d157a171188d75092f12\",\n \"6538d15fa202483e3a67fde3\",\n \"6538d1637d8721381c300b1b\",\n \"6538d167c2cb31a07e5329c3\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-08-23T12:15:04.558000Z\",\n \"created_at\": \"2023-08-23T12:15:04.558000Z\"\n }\n ]\n}"},{"id":"a2832cb5-7be2-45c2-981b-139f456c7560","name":"401 - Not logged in","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","description":"Token provided in the login request.","type":"text"},{"key":"username","value":"{{user}}","description":"Email associated with the user account.","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"created_from\": \"2023-01-01T10:00:00.000000Z\",\n \"updated_from\": \"2023-01-01T10:00:00.000000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/index"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0001\",\n \"message\": \"Login needed\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"35318f2d-30aa-4de3-a4b8-f2e47b8bf2b4"},{"name":"Create rate plan","id":"4b06b720-adfa-4ea9-87ee-c795a2ab949d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"username","value":"{{user}}","description":"

Email associated with the user account.

\n","type":"text"},{"key":"token","value":"{{token}}","description":"

Token provided in the login request.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate_plan_name\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\"\n },\n \"pms_mappings\": [\n \"rate_plan_pms_code\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans","description":"

This request allows you to create a new Rate Plan in BEONx, supporting the \"automatic\" mode, where individual rate codes cannot be modified, instead they are generated automatically based on the Rate Plan configuration.

Key Steps:

A new rate plan will be created.
Multiple rate codes will be generated. Considering this example:
- 4 Spaces with 3 occupancies for each space (2-0, 1-0, 2-1).
- 2 Meal Plans: room only and breakfast.
- Total: 4 spaces * 3 occupancies * 2 meal plans = 24 Rate Codes.
\n
The rate plan will be linked to the Property Management System (PMS).
Optionally, the rate plan can be linked to the Channel Manager, allowing rates to be sent after the next recommendation.

Response

The created Rate Plan will be returned in the same format as \"Get rate plans\".

Request 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Required	Type	Values	Default
name	Rate Plan name, visible to users	Yes	string	*
meal_plan	Meal plans for which this rate plan is sold. Multiple values allowed	Yes	string[]	`roomonly`, `breakfast`, `allinclusive`, `halfboard`, `fullboard`
cancel_charge	Indicates if the rate's cancellation has any charge for the client	Yes	string[]	`free`, `special`, `no`. See the Cancel Policies table for more detail
auto_configuration_pricing	Configuration necessary for generating rate codes	Yes	object	See the Auto Configuration Pricing Table for more details
pms_mappings	Codes representing this entity in the PMS. Multiple values allowed	Yes	string[]
mlos	Minimum length of stay	No	number	A number greater than or equal to 1	1
space_ids	Spaces associated with this rate plan.	No	string[], null	null	An array of the IDs of configured spaces at BEONx. Using `null` will include all available spaces.
min_adv_reservation	Minimum days prior to check-in for rate plan availability	No	number, null	A number greater than or equal to 0	null
max_adv_reservation	Maximum days prior to check-in for rate plan availability	No	number, null	A number greater than or equal to 0	null
quota_min	Minimum allotment of rooms associated with the rate plan	No	number, null	A number greater than or equal to 1	null
quota_max	Maximum allotment of rooms associated with the rate plan	No	number, null	A number greater than or equal to 1	null
travel_window	Check-in date availability period	No	TravelWindow[]	See the Travel Window table for more details	[]
booking_window	Booking date availability period	No	BookingWindow[]	See the Booking Window table for more details	[]
channel_manager_mappings	Channel manager mapping configuration for recommendations	No	ChannelManagerMapping[]	See the Channel Manager Mapping table for more details	[]

Cancel Policies

Use the following values to define cancellation policies for rate plans:

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

Value	Description
free	Cancellation is free for the client.
no	The entire reservation revenue will be charged if canceled.
special	Special conditions apply when canceled, such as a 50% charge of the total price if canceled 7 days before check-in.

Auto Configuration Pricing

The auto_configuration_pricing field contains the necessary values to auto-generate all Rate Codes related to the Rate Plan. With well-configured inventory in BEONx, this process can seamlessly create many rate plans.

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

Field	Description	Required	Type	Values	Default
type	Rate plan type	Yes	string	dynamic, indexed
base_rate_plan_id	Base rate plan for indexed rate plans	Required with indexed rate plans. Must be null for dynamic rate plans.	string	null	ID of another rate plan.
supplement_ids	Supplements to apply to generated rate codes	No. Only available if `indexed`. If no supplements are passed, the price recommendations will be the same as the base rate plan.	string[]	IDs of supplements to be used on indexed rates.	[]
all_spaces_open	Determine if all rate codes should be generated with an open price for a dynamic rate plan	No. Only available on `dynamic`	boolean	true: all spaces and occupancies will have dynamic pricing. false: meal plan and space	true

Channel Manager Mappings

The channel_manager_mappings field contains the channel manager configuration necessary to enable channel manager recommendations publishing features. Mapping a rate code to the channel manager will immediately connect it to the third-party system.

Key Information:

If Autopilot (automatic sending of recommendations) is enabled by the client, the rate will be pushed immediately after the next recommendation is provided.
Security prices can be configured to prevent human errors. These prices should be set to completely unacceptable values. They will be used for Autopilot sends as well as manual sends where the user can modify the prices.

Provide an array with the following values for each individual space, occupancy, and meal plan you want to activate for sending.

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

Field	Description	Required	Type	Values
space_id	Space	Yes	string	ID of an existing space included in this rate plan
code	Code that identifies this rate in the channel manager	Yes	string	string
meal_plan	One of the meal plans passed in the root `meal_plan` attribute of the Rate Plan	Yes	string	roomonly, breakfast, allinclusive, halfboard, fullboard
adults	Number of adults. Should match the space occupancy	Yes	number
children	Number of children. Should match the space occupancy	Yes	number
min_price	Minimum price allowed to be sent to the channel manager. If the recommendation is lower than this price, all the sends will be aborted. This serves as a last barrier to prevent human errors, especially for supplement configuration. We recommend using this field, at least for dynamic pricing plans.	Yes	number, null	If null, no security limit will be used.
max_price	Maximum price allowed to be sent to the channel manager. If the recommendation is higher than this price, all the sends will be aborted. This serves as a last barrier to prevent human errors, especially for supplement configuration.	Yes	number, null	If null, no security limit will be used.

Travel Window / Booking Window Structure

To configure travel and booking windows, you need to provide an array of elements with the following structure:

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

Field	Description	Required	Type	Values
date_start	Start date of the period	Yes	string	A date in Y-m-d format. For example: `2023-10-26`
date_end	End date of the period	Yes	string	A date in Y-m-d format. For example: `2023-10-26`
dow	Days of the week	Yes	number[]	Number representing the day of the week. Sunday (0). For example, Sunday and Monday: `[0, 1]`

","urlObject":{"path":["v2.4","configuration","{{contractId}}","ratePlans"],"host":["https://api.beonprice.com"],"query":[],"variable":[]}},"response":[{"id":"4fc2c1f3-aaed-4df0-9cd1-54e6cce72d26","name":"200 - Create basic dynamic/open","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"dynamic\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\"\n },\n \"pms_mappings\": [\n \"foo\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"6543508bcec19b6f7127e5c0\",\n \"name\": \"dynamic\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\",\n \"630efef3e3a51820ad33c0bb\",\n \"630efef3e3a51820ad33c0bd\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-11-02T07:32:28.219000Z\",\n \"created_at\": \"2023-11-02T07:32:28.219000Z\",\n \"channel_manager_mappings\": []\n }\n}"},{"id":"aa186f0f-f8b8-4cc6-a9a0-3bb776205a8f","name":"200 - Create basic indexed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"indexed\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"indexed\",\n \"base_rate_plan_id\": \"6543508bcec19b6f7127e5c0\"\n },\n \"pms_mappings\": [\n \"foo\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"654350bbc26ed334ea2fe356\",\n \"name\": \"indexed\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6543508bcec19b6f7127e5c0\",\n \"supplement_ids\": [],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\",\n \"630efef3e3a51820ad33c0bb\",\n \"630efef3e3a51820ad33c0bd\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-11-02T07:33:16.011000Z\",\n \"created_at\": \"2023-11-02T07:33:16.011000Z\",\n \"channel_manager_mappings\": []\n }\n}"},{"id":"fced6b76-be1b-42d2-b765-b6da534bfbf0","name":"200 - Create with travel window","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"with_travel_window\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\"\n },\n \"pms_mappings\": [\n \"foo\"\n ],\n \"travel_window\": [\n {\n \"date_start\": \"2023-10-25\",\n \"date_end\": \"2023-11-25\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"654350d82bbfc24e016a9ee5\",\n \"name\": \"with_travel_window\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [\n {\n \"date_start\": \"2023-10-25T00:00:00.000000Z\",\n \"date_end\": \"2023-11-25T00:00:00.000000Z\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\",\n \"630efef3e3a51820ad33c0bb\",\n \"630efef3e3a51820ad33c0bd\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-11-02T07:33:44.425000Z\",\n \"created_at\": \"2023-11-02T07:33:44.425000Z\",\n \"channel_manager_mappings\": []\n }\n}"},{"id":"20e84ee6-8433-4fc2-a00e-cc3499dd7259","name":"200 - Create wiht booking window","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"with_booking_window\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\"\n },\n \"pms_mappings\": [\n \"foo\"\n ],\n \"booking_window\": [\n {\n \"date_start\": \"2023-10-25\",\n \"date_end\": \"2023-11-25\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"654350e581d3a97d5a5bba8a\",\n \"name\": \"with_booking_window\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [\n {\n \"date_start\": \"2023-10-25T00:00:00.000000Z\",\n \"date_end\": \"2023-11-25T00:00:00.000000Z\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\",\n \"630efef3e3a51820ad33c0bb\",\n \"630efef3e3a51820ad33c0bd\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-11-02T07:33:57.387000Z\",\n \"created_at\": \"2023-11-02T07:33:57.387000Z\",\n \"channel_manager_mappings\": []\n }\n}"},{"id":"895d9203-d268-4e23-bb71-888507f10882","name":"200 - Create with channel manager mappings","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"with_channel_mappings\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\"\n ],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"channel_manager_mappings\": [\n {\n \"space_id\": \"630efef3e3a51820ad33c0b9\",\n \"adults\": 2,\n \"children\": 0,\n \"meal_plan\": \"roomonly\",\n \"code\": \"bar\",\n \"safety_price_min\": 100,\n \"safety_price_max\": 200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"654351f480341c5a6579b590\",\n \"name\": \"with_channel_mappings\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 1,\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"type\": \"dynamic\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\"\n ],\n \"quota_min\": null,\n \"quota_max\": null,\n \"updated_at\": \"2023-11-02T07:38:28.638000Z\",\n \"created_at\": \"2023-11-02T07:38:28.638000Z\",\n \"channel_manager_mappings\": [\n {\n \"code\": \"bar\",\n \"safety_price_min\": 100,\n \"safety_price_max\": 200,\n \"space_id\": \"630efef3e3a51820ad33c0b9\",\n \"meal_plan\": \"roomonly\",\n \"adults\": 2,\n \"children\": 0\n }\n ]\n }\n}"},{"id":"fce390fd-1665-4d05-8b4e-0b70d3d57308","name":"200 - Create with complex configuration","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"with_all_configuration\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"auto_configuration_pricing\": {\n \"type\": \"indexed\",\n \"base_rate_plan_id\": \"6543508bcec19b6f7127e5c0\",\n \"supplement_ids\": [\n \"630efef4e3a51820ad33c0c8\"\n ]\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\"\n ],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"mlos\": 2,\n \"min_adv_reservation\": 1,\n \"max_adv_reservation\": 10,\n \"quota_min\": 1,\n \"quota_max\": 10,\n \"travel_window\": [\n {\n \"date_start\": \"2023-10-25\",\n \"date_end\": \"2023-11-25\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"booking_window\": [\n {\n \"date_start\": \"2023-10-25\",\n \"date_end\": \"2023-11-25\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"channel_manager_mappings\": [\n {\n \"space_id\": \"630efef3e3a51820ad33c0b9\",\n \"adults\": 2,\n \"children\": 0,\n \"meal_plan\": \"roomonly\",\n \"code\": \"bar\",\n \"safety_price_min\": 100,\n \"safety_price_max\": 200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"rate_plan\": {\n \"_id\": \"65435280fb0acd72d94f7a07\",\n \"name\": \"with_all_configuration\",\n \"meal_plan\": [\n \"roomonly\"\n ],\n \"cancel_charge\": [\n \"free\"\n ],\n \"mlos\": 2,\n \"min_adv_reservation\": 1,\n \"max_adv_reservation\": 10,\n \"travel_window\": [\n {\n \"date_start\": \"2023-10-25T00:00:00.000000Z\",\n \"date_end\": \"2023-11-25T00:00:00.000000Z\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"booking_window\": [\n {\n \"date_start\": \"2023-10-25T00:00:00.000000Z\",\n \"date_end\": \"2023-11-25T00:00:00.000000Z\",\n \"dow\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n }\n ],\n \"pms_mappings\": [\n \"foo\"\n ],\n \"auto_configuration_pricing\": {\n \"base_rate_plan_id\": \"6543508bcec19b6f7127e5c0\",\n \"supplement_ids\": [\n \"630efef4e3a51820ad33c0c8\"\n ],\n \"type\": \"indexed\"\n },\n \"space_ids\": [\n \"630efef3e3a51820ad33c0b9\"\n ],\n \"quota_min\": 1,\n \"quota_max\": 10,\n \"updated_at\": \"2023-11-02T07:40:48.682000Z\",\n \"created_at\": \"2023-11-02T07:40:48.682000Z\",\n \"channel_manager_mappings\": [\n {\n \"code\": \"bar\",\n \"safety_price_min\": 100,\n \"safety_price_max\": 200,\n \"space_id\": \"630efef3e3a51820ad33c0b9\",\n \"meal_plan\": \"roomonly\",\n \"adults\": 2,\n \"children\": 0\n }\n ]\n }\n}"},{"id":"e40af165-5685-4963-9ba7-4b2f4fc4fbcb","name":"401 - Not loged in","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"username","value":"{{user}}","description":"Email associated with the user account."},{"key":"token","value":"{{token}}","description":"Token provided in the login request."}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo\",\n \"meal_plan\": [\"roomonly\"],\n \"cancel_charge\": \"free\",\n \"auto_configuration_pricing\": {\n \"type\": \"dynamic\",\n \"pms_mappings\": \"foo\",\n \"base_rate_plan_id\": null,\n \"supplement_ids\": [],\n \"all_spaces_open\": true\n },\n \"pms_mappings\": [],\n \"mlos\": 1,\n \"space_ids\": [{{spaceId}}],\n \"min_adv_reservation\": null,\n \"max_adv_reservation\": null,\n \"quota_max\": null,\n \"quota_min\": null,\n \"travel_window\": [],\n \"booking_window\": [],\n \"channel_manager_mappings\": {\n \"space_id\": {{spaceId}},\n \"meal_plan\": \"roomonly\",\n \"code\": \"foo\",\n \"adults\": 2,\n \"children\": 0,\n \"min_price\": null,\n \"max_price\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/create"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0001\",\n \"message\": \"Login needed\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"4b06b720-adfa-4ea9-87ee-c795a2ab949d"},{"name":"Delete all rate plans","id":"5b9daa73-d386-490e-a688-2bdbf8748352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"username","value":"{{user}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/deleteAll","description":"

Deletes all the rate plans generated.

Notice that this will empty your rate plan configuration.

\n","urlObject":{"path":["v2.4","configuration","{{contractId}}","ratePlans","deleteAll"],"host":["https://api.beonprice.com"],"query":[],"variable":[]}},"response":[{"id":"bd7125e6-a5af-4540-8622-772cc3b6b480","name":"200 - Delete all rate plans","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"username","value":"{{user}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"25216f3f-9c87-4d04-8566-805e1f1e2db3","name":"401 - Login needed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"username","value":"{{user}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"url":"https://api.beonprice.com/v2.4/configuration/{{contractId}}/ratePlans/delete"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"0001\",\n \"message\": \"Login needed\",\n \"moreInfo\": \"\"\n }\n}"}],"_postman_id":"5b9daa73-d386-490e-a688-2bdbf8748352"}],"id":"36d466b7-14c9-4eb1-9373-68c34aa46d85","description":"

These requests allow you to manage the inventory configuration at BEONx.

Index Entities

You can retrieve information about the following entities:

Spaces
Supplements
Rate Plans

To check for creations or modifications, these requests allow you to specify created_from or update_from to monitor changes made at BEONx. The recommended date format is ISO-8601.

Rate Plan Management

Create a Rate Plan

You can synchronize the creation of rate plans between BEONx and your PMS (Property Management System) by using the \"Create Rate Plan\" request.

Delete All Rate Plans

For testing purposes, we provide a \"Delete All Rate Plans\" request. This request offers a convenient way to start anew without the need to contact BEONx. Single deletion is not yet offered because indexed rate plans depend on each other; this request provides a full, safe delete.

\n","_postman_id":"36d466b7-14c9-4eb1-9373-68c34aa46d85"}],"event":[{"listen":"prerequest","script":{"id":"37648006-14e3-4136-9df6-adb3d93fe5eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6e6924d6-6d1b-49b5-b47a-0edc4080d46d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"domain","value":"https://api.beonprice.com","type":"string"}]}