{ "item": [ { "name": "Properties", "description": { "content": "Catalog, per-property detail, rates, availability and photos.", "type": "text/plain" }, "item": [ { "name": "List properties", "request": { "name": "List properties", "description": { "content": "Paginated catalog of live properties (limited to the allow-list for restricted keys). Poll with `updated_since` for incremental sync.", "type": "text/plain" }, "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number, from 1." }, { "disabled": true, "key": "per_page", "value": "50", "description": "Page size." }, { "disabled": true, "key": "updated_since", "value": "{{since}}", "description": "Only properties changed at or after this instant (ISO 8601)." }, { "disabled": true, "key": "location", "value": "", "description": "Location id from GET /locations; matches the location and every descendant." }, { "disabled": true, "key": "sort", "value": "id", "description": "Sort field; prefix with - for descending." }, { "disabled": true, "key": "checkin", "value": "{{checkin}}", "description": "With checkout: only properties free for the whole stay." }, { "disabled": true, "key": "checkout", "value": "{{checkout}}", "description": "With checkin." }, { "disabled": true, "key": "guests", "value": "", "description": "Minimum sleeps." }, { "disabled": true, "key": "rooms", "value": "", "description": "Minimum bedrooms." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "A page of properties.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"properties\": [\n {\n \"id\": 117388,\n \"name\": \"Necker Island\",\n \"type\": \"villa\",\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay/silent-waters-villa-553\",\n \"updated_at\": \"2010-04-24T10:37:00.789Z\",\n \"updated\": {\n \"content\": \"1955-03-05T08:42:04.019Z\",\n \"rates\": \"1991-09-14T15:31:18.237Z\",\n \"availability\": \"2021-05-24T20:07:43.065Z\",\n \"images\": \"1950-06-29T05:45:03.467Z\"\n },\n \"bedrooms\": 24,\n \"bathrooms\": 20,\n \"sleeps\": 48,\n \"rating\": 4.8,\n \"latitude\": 18.44104,\n \"longitude\": -77.98475,\n \"location\": {\n \"id\": 213,\n \"name\": \"Necker Island\",\n \"path\": [\n \"Caribbean\",\n \"British Virgin Islands (BVI)\",\n \"Necker Island\"\n ],\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay\"\n },\n \"image\": {\n \"caption\": \"Infinity pool at sunset\",\n \"url\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1\",\n \"sizes\": {\n \"thumb\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-400w\",\n \"medium\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-800w\",\n \"large\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-1600w\"\n }\n }\n },\n {\n \"id\": 117388,\n \"name\": \"Necker Island\",\n \"type\": \"villa\",\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay/silent-waters-villa-553\",\n \"updated_at\": \"1989-08-03T08:14:01.238Z\",\n \"updated\": {\n \"content\": \"2011-01-05T02:33:53.368Z\",\n \"rates\": \"1978-05-13T19:44:59.888Z\",\n \"availability\": \"1961-03-26T11:01:48.332Z\",\n \"images\": \"2019-03-29T11:05:15.451Z\"\n },\n \"bedrooms\": 24,\n \"bathrooms\": 20,\n \"sleeps\": 48,\n \"rating\": 4.8,\n \"latitude\": 18.44104,\n \"longitude\": -77.98475,\n \"location\": {\n \"id\": 213,\n \"name\": \"Necker Island\",\n \"path\": [\n \"Caribbean\",\n \"British Virgin Islands (BVI)\",\n \"Necker Island\"\n ],\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay\"\n },\n \"image\": {\n \"caption\": \"Infinity pool at sunset\",\n \"url\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1\",\n \"sizes\": {\n \"thumb\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-400w\",\n \"medium\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-800w\",\n \"large\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-1600w\"\n }\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 50,\n \"total\": 3970,\n \"total_pages\": 80,\n \"next\": \"/properties?per_page=50&page=2\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid input. `error.validation` maps each offending field (dotted path for nested fields) to a message; every problem is reported at once.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "updated_since", "value": "" }, { "key": "location", "value": "" }, { "key": "sort", "value": "id" }, { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "guests", "value": "" }, { "key": "rooms", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List property changes", "request": { "name": "List property changes", "description": { "content": "Lightweight change log for incremental sync. Without `since`, every live property with its area change times. With `since`, only live properties that changed in some area at or after it, plus properties that left the catalog after it (`status: removed`) so you can drop them. Refreshed hourly: poll no more often than that and pass the time of your previous run as `since`.", "type": "text/plain" }, "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "since", "value": "{{since}}", "description": "Only changes at or after this instant (ISO 8601)." }, { "disabled": true, "key": "page", "value": "1", "description": "Page number, from 1." }, { "disabled": true, "key": "per_page", "value": "500", "description": "Page size." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "A page of changes, ordered by property id.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"changes\": [\n {\n \"status\": \"live\"\n },\n {\n \"status\": \"live\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 50,\n \"total\": 3970,\n \"total_pages\": 80,\n \"next\": \"/properties?per_page=50&page=2\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid input. `error.validation` maps each offending field (dotted path for nested fields) to a message; every problem is reported at once.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "500" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a property", "request": { "name": "Get a property", "description": { "content": "Everything shown on the property page: the catalog summary (the same shape as `GET /properties`) plus descriptions, rooms and beds, amenities, policies and reviews. Rates, availability and photos have their own endpoints. Re-fetch when `updated.content` changes.", "type": "text/plain" }, "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{propertyId}}", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Property content.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amenities\": [\n {\n \"category\": \"General\",\n \"items\": [\n \"Pool\",\n \"Wifi\"\n ]\n },\n {\n \"category\": \"General\",\n \"items\": [\n \"Pool\",\n \"Wifi\"\n ]\n }\n ],\n \"amenity_notes\": \"

Daily housekeeping; chef available on request.

\",\n \"arrival\": {\n \"checkin_time\": \"15:00\",\n \"checkout_time\": \"12:00\",\n \"notes\": \"The property manager meets guests on arrival.\"\n },\n \"bathrooms\": 20,\n \"bedrooms\": 24,\n \"description\": \"

A secluded nine-bedroom estate on the cliffs above Montego Bay, with an infinity pool and full staff.

\",\n \"house_rules\": \"No events without approval. Quiet hours after 11pm.\",\n \"id\": 117388,\n \"image\": {\n \"caption\": \"Infinity pool at sunset\",\n \"url\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1\",\n \"sizes\": {\n \"thumb\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-400w\",\n \"medium\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-800w\",\n \"large\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-1600w\"\n }\n },\n \"inclusions\": \"Breakfast and daily housekeeping included.\",\n \"latitude\": 18.44104,\n \"location\": {\n \"id\": 213,\n \"name\": \"Necker Island\",\n \"path\": [\n \"Caribbean\",\n \"British Virgin Islands (BVI)\",\n \"Necker Island\"\n ],\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay\"\n },\n \"location_description\": \"Ten minutes from Sangster International Airport, near Rose Hall.\",\n \"longitude\": -77.98475,\n \"name\": \"Necker Island\",\n \"policies\": {\n \"children\": \"null\",\n \"pets\": \"no\",\n \"smoking\": \"null\",\n \"events\": \"yes\",\n \"seniors\": \"no\",\n \"wheelchair_accessible\": \"null\",\n \"long_term\": \"on_request\"\n },\n \"rating\": 4.8,\n \"reviews\": [\n {\n \"author\": \"Sarah M.\",\n \"date\": \"2026-03-14\",\n \"title\": \"Perfect family week\",\n \"text\": \"The staff were wonderful and the views even better than the photos.\",\n \"rating\": 5\n },\n {\n \"author\": \"Sarah M.\",\n \"date\": \"2026-03-14\",\n \"title\": \"Perfect family week\",\n \"text\": \"The staff were wonderful and the views even better than the photos.\",\n \"rating\": 5\n }\n ],\n \"rooms\": {\n \"bedrooms\": [\n {\n \"name\": \"Master suite\",\n \"type\": \"string\",\n \"sleeps\": 2087,\n \"beds\": {\n \"king\": 5463,\n \"queen\": 2672,\n \"double\": 6466,\n \"single\": 1838,\n \"bunk\": 3401,\n \"sofa_bed\": 3640,\n \"crib\": 7991,\n \"child\": 9112\n },\n \"notes\": \"Ocean view, private terrace.\"\n },\n {\n \"name\": \"Master suite\",\n \"type\": \"string\",\n \"sleeps\": 2897,\n \"beds\": {\n \"king\": 79,\n \"queen\": 5042,\n \"double\": 6409,\n \"single\": 7768,\n \"bunk\": 7816,\n \"sofa_bed\": 1414,\n \"crib\": 1113,\n \"child\": 256\n },\n \"notes\": \"Ocean view, private terrace.\"\n }\n ],\n \"bathrooms\": [\n {\n \"name\": \"Master bathroom\",\n \"type\": \"full\",\n \"features\": [\n \"bidet\",\n \"shower_tub_combo\"\n ],\n \"notes\": \"Outdoor rain shower.\"\n },\n {\n \"name\": \"Master bathroom\",\n \"type\": \"full\",\n \"features\": [\n \"outdoor\",\n \"whirlpool\"\n ],\n \"notes\": \"Outdoor rain shower.\"\n }\n ],\n \"bedroom_notes\": \"string\",\n \"bathroom_notes\": \"string\"\n },\n \"sleeps\": 48,\n \"staff\": [\n \"Chef\",\n \"House Manager\"\n ],\n \"type\": \"villa\",\n \"updated\": {\n \"content\": \"2026-02-22T22:22:02.793Z\",\n \"rates\": \"2018-11-02T14:03:08.520Z\",\n \"availability\": \"1954-05-29T05:41:39.068Z\",\n \"images\": \"2013-03-11T08:41:25.095Z\"\n },\n \"updated_at\": \"1955-01-13T18:50:01.747Z\",\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay/silent-waters-villa-553\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown or unpublished property, or outside the key's allow-list.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get rates, fees and taxes", "request": { "name": "Get rates, fees and taxes", "description": { "content": "Seasonal rate periods, the default rate, fees, taxes and rate notes: the inputs to a quote.", "type": "text/plain" }, "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "from", "value": "", "description": "Exclude periods ending before this date. Default today." }, { "disabled": true, "key": "to", "value": "", "description": "Exclude periods starting after this date. Default open." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{propertyId}}", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Rate sheet.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"property_id\": 553,\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"from\": \"2026-10-05\",\n \"to\": \"1993-04-08\",\n \"rates\": [\n {\n \"id\": 90412,\n \"name\": \"Low Season: 1 - 7 people\",\n \"start_date\": \"2027-04-15\",\n \"end_date\": \"2027-12-14\",\n \"rooms\": 4,\n \"nightly\": 2853,\n \"weekly\": 4433.676283127707,\n \"monthly\": 5863.31410994224,\n \"min_stay\": 5,\n \"balance_days\": 60,\n \"currency\": \"USD\",\n \"cancellation_policy\": {\n \"name\": \"Standard\",\n \"description\": \"Deposit refundable until 60 days before arrival, less a 10% fee.\"\n }\n },\n {\n \"id\": 90412,\n \"name\": \"Low Season: 1 - 7 people\",\n \"start_date\": \"2027-04-15\",\n \"end_date\": \"2027-12-14\",\n \"rooms\": 4,\n \"nightly\": 2853,\n \"weekly\": 1031.9968522588529,\n \"monthly\": 1970.4824156551792,\n \"min_stay\": 5,\n \"balance_days\": 60,\n \"currency\": \"USD\",\n \"cancellation_policy\": {\n \"name\": \"Standard\",\n \"description\": \"Deposit refundable until 60 days before arrival, less a 10% fee.\"\n }\n }\n ],\n \"default_rate\": {\n \"id\": 90400,\n \"name\": \"Default\",\n \"rooms\": 9,\n \"nightly\": 4250,\n \"weekly\": 9990.185763311103,\n \"monthly\": 5644.66981008123,\n \"min_stay\": 5,\n \"balance_days\": 60,\n \"currency\": \"USD\"\n },\n \"fees\": [\n {\n \"name\": \"Damage Waiver\",\n \"description\": \"Covers accidental damage up to $2,500.\",\n \"amount\": 299,\n \"currency\": \"USD\",\n \"type\": \"flat\",\n \"type_text\": \"per night\",\n \"refundable\": false,\n \"taxable\": false\n },\n {\n \"name\": \"Damage Waiver\",\n \"description\": \"Covers accidental damage up to $2,500.\",\n \"amount\": 299,\n \"currency\": \"USD\",\n \"type\": \"flat\",\n \"type_text\": \"per night\",\n \"refundable\": true,\n \"taxable\": false\n }\n ],\n \"taxes\": [\n {\n \"name\": \"General Consumption Tax\",\n \"rate\": 10,\n \"description\": \"string\"\n },\n {\n \"name\": \"General Consumption Tax\",\n \"rate\": 10,\n \"description\": \"string\"\n }\n ],\n \"notes\": \"Holiday weeks (Dec 20 - Jan 5) require a 7-night minimum.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid input. `error.validation` maps each offending field (dotted path for nested fields) to a message; every problem is reported at once.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown or unpublished property, or outside the key's allow-list.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", ":id", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get booked dates", "request": { "name": "Get booked dates", "description": { "content": "GET /properties/{id}/availability — booked date ranges for one property.", "type": "text/plain" }, "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "from", "value": "", "description": "Window start. Default today." }, { "disabled": true, "key": "to", "value": "", "description": "Window end. Default from + 2 years." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{propertyId}}", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Booked ranges in the window.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"property_id\": 553,\n \"from\": \"2026-10-05\",\n \"to\": \"2028-10-05\",\n \"booked\": [\n {\n \"checkin\": \"2026-12-20\",\n \"checkout\": \"2027-01-03\",\n \"checkin_full_day\": false,\n \"checkout_full_day\": true,\n \"status\": \"confirmed\"\n },\n {\n \"checkin\": \"2026-12-20\",\n \"checkout\": \"2027-01-03\",\n \"checkin_full_day\": true,\n \"checkout_full_day\": false,\n \"status\": \"hold\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid input. `error.validation` maps each offending field (dotted path for nested fields) to a message; every problem is reported at once.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown or unpublished property, or outside the key's allow-list.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", ":id", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get the photo gallery", "request": { "name": "Get the photo gallery", "description": { "content": "GET /properties/{id}/images — full photo gallery for one property.", "type": "text/plain" }, "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{propertyId}}", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Photos in display order.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"property_id\": 553,\n \"images\": [\n {\n \"id\": 48211,\n \"position\": 1,\n \"caption\": \"Infinity pool at sunset\",\n \"url\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1\",\n \"sizes\": {\n \"thumb\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-400w\",\n \"medium\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-800w\",\n \"large\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-1600w\"\n },\n \"width\": 1920,\n \"height\": 1080\n },\n {\n \"id\": 48211,\n \"position\": 1,\n \"caption\": \"Infinity pool at sunset\",\n \"url\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1\",\n \"sizes\": {\n \"thumb\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-400w\",\n \"medium\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-800w\",\n \"large\": \"https://cdn.rentalescapes.com/images/2f6c1a3e-7b4d-4e1a-9c2b-5d8e0f1a2b3c/silent-waters-villa-1-1600w\"\n },\n \"width\": 1920,\n \"height\": 1080\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown or unpublished property, or outside the key's allow-list.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Price a stay", "request": { "name": "Price a stay", "description": { "content": "Authoritative total for a specific stay, including fees, taxes and discounts.", "type": "text/plain" }, "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "checkin", "value": "{{checkin}}", "description": "(Required) Today or later." }, { "disabled": false, "key": "checkout", "value": "{{checkout}}", "description": "(Required) After checkin." }, { "disabled": true, "key": "adults", "value": "2", "description": "Adults in the party. Used for capacity and for per-adult and per-guest fees." }, { "disabled": true, "key": "children", "value": "0", "description": "Children in the party. They count toward capacity and per-guest fees, and per-child fees use this number." }, { "disabled": true, "key": "bedrooms", "value": "", "description": "Bedrooms to price; raised to fit the guests at two per room." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{propertyId}}", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Quote.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"property_id\": 553,\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"price_on_request\": false,\n \"stay\": {\n \"checkin\": \"2026-12-20\",\n \"checkout\": \"2026-12-27\",\n \"nights\": 7,\n \"guests\": {\n \"adults\": 4,\n \"children\": 1\n },\n \"bedrooms\": 3\n },\n \"totals\": {\n \"rate\": 26901,\n \"discounts\": 0,\n \"fees\": 299,\n \"taxes\": 2690.1,\n \"total\": 29890.1,\n \"refundable_deposits\": 0,\n \"total_payable\": 29890.1\n },\n \"average_nightly_rate\": 3843,\n \"tax_rate\": 10,\n \"accuracy\": \"estimated\",\n \"rate_range\": {\n \"min\": 2853,\n \"max\": 4250\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid input. `error.validation` maps each offending field (dotted path for nested fields) to a message; every problem is reported at once.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown or unpublished property, or outside the key's allow-list.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "properties", ":id", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checkin", "value": "" }, { "key": "checkout", "value": "" }, { "key": "adults", "value": "2" }, { "key": "children", "value": "0" }, { "key": "bedrooms", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Property id from the catalog." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Locations", "description": { "content": "Destination catalog with ids.", "type": "text/plain" }, "item": [ { "name": "List locations", "request": { "name": "List locations", "description": { "content": "Flat catalog of every location with live properties beneath it (counted within the allow-list for restricted keys). About 800 rows; refresh daily. Needs `locations:read`.", "type": "text/plain" }, "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Location catalog.", "originalRequest": { "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"locations\": [\n {\n \"id\": 144,\n \"parent_id\": 16,\n \"name\": \"St. James\",\n \"path\": [\n \"Caribbean\",\n \"Barbados\",\n \"St. James\"\n ],\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay\",\n \"property_count\": 185\n },\n {\n \"id\": 144,\n \"parent_id\": 16,\n \"name\": \"St. James\",\n \"path\": [\n \"Caribbean\",\n \"Barbados\",\n \"St. James\"\n ],\n \"url\": \"https://www.rentalescapes.com/rentals/luxury-villa-rentals-caribbean/jamaica/montego-bay\",\n \"property_count\": 185\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or unknown key.", "originalRequest": { "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key lacks the scope for this route or method.", "originalRequest": { "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too many requests for this key. Wait `Retry-After` seconds, then retry.", "originalRequest": { "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "Seconds to wait.", "key": "Retry-After", "value": "7638" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Something failed on our side. The message is always generic; quote `error.request_id` (also the `X-Request-Id` header) when reporting it.", "originalRequest": { "url": { "path": [ "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-RE-API-TOKEN", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Invalid inquiry.\",\n \"request_id\": \"req_7f3a9c11e2b04d5a6c8e9f01\",\n \"validation\": {\n \"stay.checkin\": \"Must not be in the past.\",\n \"contact.email\": \"Must be a valid email address.\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Inquiries", "description": { "content": "Stay requests handed to a reservations agent.", "type": "text/plain" }, "item": [ { "name": "Submit a property inquiry", "request": { "method": "POST", "description": "A stay request for one property. With a test key nothing is created and the response says \"test\": true.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": {{propertyId}},\n \"stay\": {\n \"checkin\": \"{{checkin}}\",\n \"checkout\": \"{{checkout}}\",\n \"guests\": {\n \"adults\": 2,\n \"children\": 0\n },\n \"bedrooms\": 3\n },\n \"contact\": {\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"email\": \"ada@example.com\",\n \"phone\": \"+1 514 555 0100\"\n },\n \"message\": \"Celebrating an anniversary; private chef for two dinners. Advisor: Jane Smith, jane@agency.example\",\n \"reference\": \"trip-991\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inquiries", "host": [ "{{baseUrl}}" ], "path": [ "inquiries" ] } }, "response": [] }, { "name": "Submit a general inquiry", "request": { "method": "POST", "description": "A request for a destination rather than a property. Location ids come from List locations.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination\": {\n \"id\": 144,\n \"name\": \"west coast, near Sandy Lane\"\n },\n \"stay\": {\n \"checkin\": \"{{checkin}}\",\n \"checkout\": \"{{checkout}}\",\n \"guests\": {\n \"adults\": 2,\n \"children\": 0\n }\n },\n \"budget\": {\n \"min\": 1500,\n \"max\": 4000\n },\n \"contact\": {\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"email\": \"ada@example.com\",\n \"phone\": \"+1 514 555 0100\"\n },\n \"reference\": \"trip-991\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inquiries", "host": [ "{{baseUrl}}" ], "path": [ "inquiries" ] } }, "response": [] } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Stay dates 60-67 days out and a 'since' one day back, unless you set your own.", "const day = (n) => new Date(Date.now() + n * 864e5).toISOString().slice(0, 10);", "if (!pm.variables.get('checkin')) pm.variables.set('checkin', day(60));", "if (!pm.variables.get('checkout')) pm.variables.set('checkout', day(67));", "if (!pm.variables.get('since')) pm.variables.set('since', new Date(Date.now() - 864e5).toISOString().slice(0, 19) + 'Z');" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.rentalescapes.com/v2" }, { "key": "apiKey", "value": "" }, { "key": "propertyId", "value": "553", "description": "Any id from List properties." } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-RE-API-TOKEN" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "8f3b2c71-5d4e-4a9b-9c1f-2e6a7b8c9d01", "name": "Rental Escapes Partner API", "description": "Partner API v1.0.0. Reference and guides: https://developers.rentalescapes.com\n\nPick the Test or Live environment and paste your key into its `apiKey` value. Test keys (re_test_) never create inquiries.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" } }