{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"179dc035-4f20-49c0-8589-3cba6bf9ea1e","name":"PXSOL Public API","description":"The Pxsol integration API or also Pxsol API version 2 is a public API layer that will integrate the services that Pxsol already provides and will provide in the future. The objectives of this project are:\n\n- Allow external parties to easily access the services available to Pxsol.\n    \n- Build an agile, secure and scalable integration layer.\n    \n\n**Support**\n\n[api@pxsol.com](https://api@pxsol.com)\n\n# **🧩 General FAQ**\n\n---\n\n## 1\\. What functionalities does the Pxsol API offer?\n\nThe Pxsol public API allows you to integrate external systems with the PMS to:\n\n- View reservations.\n    \n- Create reservations from external systems.\n    \n- Send and update availability.\n    \n- Send and update rates.\n    \n- Obtain hotel information, including:\n    \n    - General property information (description, address, photos, etc.)\n        \n    - Categories.\n        \n    - Rate plans.\n        \n    - Policies.\n        \n- List and view accounting documents:\n    \n    - Invoices.\n        \n    - Receipts.\n        \n    - Other supporting documents.\n        \n- View the **“Nightly Report”**.\n    \n\n---\n\n## 2\\. What type of authentication does the API use?\n\nThe API uses **Bearer Token authentication**, which must be sent in the `Authorization` header of each request.  \nThe token is provided by the Pxsol Product team.\n\n---\n\n## 3\\. Does each property need a different token?\n\nNot necessarily. Pxsol supports two authentication methods:\n\n- **Explicit authentication**: The token is generated by manually associating the properties to which it will have access.\n    \n- **Application-linked authentication**: The token is linked to a Pxsol application and allows access to all properties that have that application installed.\n    \n\nIn both cases, the token's scope is defined at the time of its creation.\n\n---\n\n## 4\\. How do I obtain an access token?\n\nThe access token and associated permissions are requested by contacting the Pxsol Product team via email at:  \n📧 [<b>api@pxsol.com</b>](https://mailto:api@pxsol.com)\n\n---\n\n## 5\\. Is there a cost to use the API?\n\nAPI access:\n\n- Is only available with certain plans.\n    \n\nTo confirm if a property can access the API, please contact:  \n📧 [<b>api@pxsol.com</b>](https://mailto:api@pxsol.com)\n\n---\n\n## 6\\. How can I view reservations?\n\nThe API offers endpoints that allow you to:\n\n- View reservations by date range, either by stay date or by creation date.\n    \n- View specific reservations using their ID.\n    \n\n---\n\n## 7\\. Can I send availability to the PMS?\n\nYes. The API allows you to update availability by date and category, respecting the structure configured in the hotel.\n\n---\n\n## 8\\. What data can I send when updating rates?\n\nThe rate update endpoints allow you to send and manage the following information:\n\n- Rates by date, either per room or by occupancy, according to the property's configuration.\n    \n- Inventory by category, indicating the number of rooms available for sale.\n    \n- Restrictions, such as:\n    \n    - Availability, defining whether a date is open or closed for sale.\n        \n    - Minimum and maximum number of nights.\n        \n    - Check-in/Check-out (COA).\n        \n    - Check-out/Check-out (COD).\n        \n\n---\n\n## 9\\. How are reservations created from the API?\n\nThe reservation creation endpoint allows you to specify, among other data:\n\n- Dates of stay.\n    \n- Category.\n    \n- Number of guests.\n    \n- Rate.\n    \n- Reservation source.\n    \n\nIn response, the PMS returns the internal ID of the created reservation.\n\n---\n\n## 10\\. What hotel information can I query?\n\nThe API exposes methods to obtain:\n\n- Categories.\n    \n- Rate plans.\n    \n- Property policies.\n    \n- Permitted occupancy.\n    \n- General and static hotel information: name, address, description, etc.\n    \n\n---\n\n## 11\\. Is there a maximum date range for querying or submitting availability and rates?\n\nThere is no defined maximum date range, but queries are subject to the usage limits established by the API.\n\n---\n\n## 12\\. Does the API have a rate limit?\n\nYes.  \nThe API has a rate limit of **1000 requests per second, per IP address**.\n\n---\n\n## 13\\. Is there a sandbox environment?\n\nNo. Currently, the API operates only in a production environment, although test properties are available for validation.\n\n---\n\n## 14\\. What should I do if I receive an error in the API?\n\nIt is recommended to follow these steps:\n\n1. Verify the parameters sent in the request.\n    \n2. Review the **Error Codes** section in the documentation.\n    \n3. Open a support case including:\n    \n    - Property and token used.\n        \n    - Endpoint invoked.\n        \n    - Date and time of the request.\n        \n    - Complete request and response.\n        \n\n---\n\n## 15\\. Where can I get more information or support?\n\nFor any further questions or inquiries, you can contact the Pxsol team by writing to:  \n📧 [<b>api@pxsol.com</b>](https://mailto:api@pxsol.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"26875477","team":578681,"collectionId":"179dc035-4f20-49c0-8589-3cba6bf9ea1e","publishedId":"2s93mAVL85","public":true,"publicUrl":"https://developers.pxsol.com","privateUrl":"https://go.postman.co/documentation/26875477-179dc035-4f20-49c0-8589-3cba6bf9ea1e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-08-12T15:44:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5e262d7af54102b632fbb86dbb1e674808a89ccf14be983a29695f8b0c571c7e","favicon":"https://res.cloudinary.com/postman/image/upload/v1597344420/team/enxtzjrdo9gbgeiq6vro.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developers.pxsol.com/view/metadata/2s93mAVL85"}