{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"dfb2ab5e-da31-43ea-8acc-af06294b83dc","name":"Channex API v.1.0","description":"Documentation for Channex HTTP JSON-based API version 1.0\n\nIf you have any comments, suggestions or recomendations, please let us know via [support@channex.io](https://support@channex.io)\n\n## API Reference\n\nThe Channex.io API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application. JSON is returned by all API responses, including errors.\n\nAPI support `GET`, `POST`, `PUT` and `DELETE` queries.\n\nEach response is valid JSON object and **MUST** contain at least one key: `error`, `meta` or `data`.\n\nIf response has success status, it **MUST** contain `data` or `meta` key at response object.\n\n`data` object **CAN** be an Object or Array of Objects.\n\nEach `data` object contain `type` and `attributes` keys with response object defenition.\n\n```\n{\n    \"meta\": {\n        \"message\": \"Human readability message\"\n    },\n    \"data\": {\n        \"type\": \"session\",\n        \"attributes\": {\n            \"field\": \"value\"\n        }\n    }\n}\n\n ```\n\nEach `POST` or `PUT` query **MUST** conatin a valid JSON Object and use `type` of passed object as key for data.\n\n```\n{\n    \"user\": {\n        \"email\": \"test@test.com\"\n    }\n}\n\n ```\n\nWhere `user` is `type` of passed entity.\n\n## Authentication\n\nChannex.io api-key authentication method.\n\nProvide your API Key at request Headers under `user-api-key` key.\n\nHow to get API Key, please read here: [https://docs.channex.io/api-v.1-documentation/api-key-access#setup-an-api-key](https://).\n\n## Errors\n\nChannex.io uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Channex.io servers.\n\nEach error response **MUST** include `errors` Object with error details.\n\n```\n{\n    \"errors\": {\n        \"details\": {\n            \"is_active\": [\n                \"can't be blank\"\n            ]\n        },\n        \"code\": \"validation_error\",\n        \"title\": \"Validation Error\"\n    }\n}\n\n ```\n\n## Status Codes\n\n`200 OK` Success Response\n\n`400 Bad Request` The request was unacceptable, often due to missing a required parameter.\n\n`401 Unauthorized` No valid API Key provided.\n\n`403 Forbidden` Access forbidden.\n\n`404 Not Found` The requested resource doesn't exist.\n\n`422 Unprocessable Entity` Validation Error.\n\n## Filtering data arguments\n\nAPI support filtering queries.\n\nBasic query:\n\n```\n/api/COLLECTION_NAME/?filter[property_id]=PROPERTY_ID\n\n ```\n\nMultiple values:\n\n```\n/api/COLLECTION_NAME/?filter[proeprty_id]=PROPERTY_ID1,PROPERTY_ID2\n\n ```\n\nMultiple fields:\n\n```\n/api/COLLECTION_NAME/?filter[property_id]=PROPERTY_ID&filter[room_type_id]=ROOM_TYPE_ID\n\n ```\n\nComparison operations:\n\n```\n/api/COLLECTION_NAME/?filter[property_id]=PROPERTY_ID&filter[date][gte]=DATE_FROM&filter[date][lte]=DATE_TO\n\n ```\n\nSupported coparison operators:\n\n- gt (greater than)\n    \n- gte (greater than or equal)\n    \n- lt (less than)\n    \n- lte (less than or equal)\n    \n- eq (equal to) default operation if you pass value after `=` symbol\n    \n- not (not equal to)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"681982","team":932099,"collectionId":"dfb2ab5e-da31-43ea-8acc-af06294b83dc","publishedId":"RztkPpne","public":true,"publicUrl":"https://documenter-api.postman.tech/view/681982/RztkPpne","privateUrl":"https://go.postman.co/documentation/681982-dfb2ab5e-da31-43ea-8acc-af06294b83dc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-02-19T04:04:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Staging","id":"185534ef-0c9f-455c-9d38-f97df74f64e4","owner":"681982","values":[{"key":"server","value":"https://staging.channex.io","enabled":true},{"key":"version","value":"v1","enabled":true},{"key":"user_api_key","value":"YOUR_API_KEY_HERE","enabled":true},{"key":"auth_token","value":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhcGkiLCJleHAiOjE1NDcwMjM2MzIsImlhdCI6MTU0NDQzMTYzMiwiaXNzIjoiYXBpIiwianRpIjoiYTVkMWY1MjUtZGJkYS00Y2QyLTg0ZTQtYTY0YmU0NDY5NjM2IiwibmJmIjoxNTQ0NDMxNjMxLCJzdWIiOiJhY2VhYWNiNi1kODMxLTQyMWQtYjRiZC0wZjcxMjAxNDkwMjgiLCJ0eXAiOiJhY2Nlc3MifQ.8kgHdWSocx0As_Z3DZ3fDDC4dVhHtv4QT-BtnqdrQWmJgAIjRNQgH6-SJovavmteQWiXsNdX2GWef5xvoJzAVA","enabled":false},{"key":"hotel_uuid","value":"","enabled":true},{"key":"group_uuid","value":"","enabled":true},{"key":"property_uuid","value":"","enabled":true},{"key":"room_type_uuid","value":"","enabled":true},{"key":"rate_plan_uuid","value":"","enabled":true},{"key":"channel_uuid","value":"","enabled":true},{"key":"booking_revision_uuid","value":"","enabled":true},{"key":"booking_uuid","value":"","enabled":true},{"key":"photo_uuid","value":"","enabled":true},{"key":"tax_uuid","value":"","enabled":true},{"key":"group_user_uuid","value":"","enabled":true},{"key":"tax_set_uuid","value":"","enabled":true},{"key":"message_thread_id","value":"","enabled":true},{"key":"webhook_uuid","value":"","enabled":true},{"key":"review_id","value":"","enabled":true,"type":"any"},{"key":"express_property_id","value":"","enabled":true,"type":"any"},{"key":"hotel_policy_uuid","value":"","enabled":true,"type":"any"},{"key":"cancellation_policy_uuid","value":"","enabled":true,"type":"any"},{"key":"extra_id","value":"","enabled":true,"type":"any"},{"key":"extra_category_id","value":"","enabled":true,"type":"default"},{"key":"user_id","value":"","enabled":true,"type":"any"}],"published":true}],"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/6f593d6b68f63176f838363560edac1706ebf89e3706bc238f0b70ec745e6858","favicon":""},"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"},{"label":"Staging","value":"681982-185534ef-0c9f-455c-9d38-f97df74f64e4"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RztkPpne"}