{ "item": [ { "id": "b8fda969-bf6c-4e6d-baae-e7d1287404eb", "name": "sdk", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ddedf2ca-a198-4d22-b328-8288fc585237", "name": "Exchange a partner's own end-user token for an SDK session.", "request": { "name": "Exchange a partner's own end-user token for an SDK session.", "description": { "content": "Called by the BROWSER, not by the partner's backend — it is the only /v1 route that does not take a Bearer API token. Identify yourself with the public `client_id` and present your end user's own access token; DriveCars validates it against the introspection endpoint configured on your partner account and mints an SDK session for the customer it names. Requires `auth_provider = partner` on your account.", "type": "text/plain" }, "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed9e1845-2385-4cc1-95ef-ed1b8aebaed6", "name": "A session token bound to the partner-authenticated customer.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_token\": \"string\",\n \"expires_at\": \"string\",\n \"partner\": {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"mor_mode\": \"drivecars\",\n \"enabled_components\": [\n \"string\",\n \"string\"\n ],\n \"theme_overrides\": {\n \"key_0\": {}\n },\n \"enabled_products\": [\n \"string\",\n \"string\"\n ],\n \"default_product\": \"string\"\n },\n \"customer\": {\n \"ref\": \"string\",\n \"email\": \"string\",\n \"name\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc05fb9d-1385-43b0-9de0-53db3da174e6", "name": "Invalid request, or `origin` missing for channel `web`.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3704195-f16f-446e-afb3-469fa2dca038", "name": "partner_auth_rejected — the partner's own auth server did not vouch for the token.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b48613-19a1-4004-a937-4414709039f5", "name": "partner_inactive, or origin_not_allowed.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c07c5b25-297d-4772-a0c7-b550cc6deb5b", "name": "unknown_client — no such client_id.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f79fae82-eb4b-41d2-bc08-f026ca9d4d78", "name": "auth_provider_not_partner — this partner has not configured partner-provided auth.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea0adc6-0fc3-4aa0-9fa3-7a4c7c230067", "name": "partner_auth_unavailable — the partner's auth server could not be reached, or answered unusably.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"string\",\n \"access_token\": \"string\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4142\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c801ebe5-9bae-4289-9372-b6e4b957c70b", "name": "Mint a widget session for a DriveCars first-party surface.", "request": { "name": "Mint a widget session for a DriveCars first-party surface.", "description": { "content": "INTERNAL. Used by the DriveCars website (server-side, holding the shared first-party key and presenting a browser Origin) and the DriveCars mobile app (presenting the signed-in customer's own JWT). The `surface` names which of the two; the partner row is resolved server-side from it and can never be chosen by the caller.", "type": "text/plain" }, "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0b629e5-7dd8-40d3-8ebf-1f118068cf3a", "name": "A session token for the first-party surface that asked.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_token\": \"string\",\n \"expires_at\": \"string\",\n \"partner\": {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"mor_mode\": \"partner_invoiced\",\n \"enabled_components\": [\n \"string\",\n \"string\"\n ],\n \"theme_overrides\": {\n \"key_0\": {}\n },\n \"enabled_products\": [\n \"string\",\n \"string\"\n ],\n \"default_product\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99281abb-07ab-4457-abf2-93709f3008a0", "name": "Invalid request, or `origin` missing for channel `web`.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ac775a6-3166-4094-bafc-50e788d29313", "name": "first_party_key_required, or no valid customer token.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af8f91d1-9dde-4b96-88be-8ba24d1d54bf", "name": "origin_not_allowed, or wrong_audience.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc797bff-b4a8-4618-a17a-8ec29d973fe0", "name": "The first-party mint is not configured in this environment.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79e28f6d-72c8-4ccd-94af-505e1ccb0185", "name": "Re-authenticate a DriveCars first-party surface and issue a NEW session.", "request": { "name": "Re-authenticate a DriveCars first-party surface and issue a NEW session.", "description": { "content": "INTERNAL. Issues a fresh session for the same surface by RE-CHECKING the same credential the mint required — the shared first-party key plus an allowlisted Origin for `website`, the signed-in customer's JWT for `mobile`. It deliberately does NOT accept the existing session token as proof: an expired or leaked session must not be able to renew itself. The response is the same envelope the mint returns.", "type": "text/plain" }, "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e696828-6047-4d81-82cb-afa2eed72629", "name": "A NEW session token for the surface that re-authenticated.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_token\": \"string\",\n \"expires_at\": \"string\",\n \"partner\": {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"mor_mode\": \"partner_invoiced\",\n \"enabled_components\": [\n \"string\",\n \"string\"\n ],\n \"theme_overrides\": {\n \"key_0\": {}\n },\n \"enabled_products\": [\n \"string\",\n \"string\"\n ],\n \"default_product\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e4108a-537e-4c4c-a5a4-4c9c89e72402", "name": "Invalid request, or `origin` missing for channel `web`.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f696d6a8-5246-449e-8160-daf72a05147b", "name": "first_party_key_required, or no valid customer token. A session token alone lands here.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "532def5d-004b-4d73-9c10-15b2e98685e1", "name": "origin_not_allowed, or wrong_audience.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e0239fd-df26-4904-9882-13d535f3d1c1", "name": "Too many mints/refreshes for this surface — shared bucket. Do not retry in a loop.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "916caa95-a283-4595-8139-dbebf07dd835", "name": "The first-party mint is not configured in this environment.", "originalRequest": { "url": { "path": [ "sdk", "sessions", "first-party", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"surface\": \"website\",\n \"channel\": \"native\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4172\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dee45d0a-a41e-4a5c-9a81-733bbac34649", "name": "Exchange the caller's API token for a short-lived SDK session token.", "request": { "name": "Exchange the caller's API token for a short-lived SDK session token.", "description": {}, "url": { "path": [ "sdk", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": \"web\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4412,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6fd55171-957e-4f16-ad67-db97a2458001", "name": "A session token for a browser or app to use against the SDK elements.", "originalRequest": { "url": { "path": [ "sdk", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"web\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4412,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_token\": \"string\",\n \"expires_at\": \"string\",\n \"partner\": {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"mor_mode\": \"drivecars\",\n \"booking_mode\": \"variable\",\n \"enabled_components\": [\n \"string\",\n \"string\"\n ],\n \"theme_overrides\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"enabled_products\": [\n \"string\",\n \"string\"\n ],\n \"default_product\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4286f2f-45ba-42c2-940b-bf29bbfd6271", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "sdk", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"web\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4412,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9fddcf-c673-43a2-8d12-f1db036e3614", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "sdk", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"web\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4412,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db8a0d9e-a4b7-4de0-a871-d95ec7b93a9b", "name": "Origin not allowed.", "originalRequest": { "url": { "path": [ "sdk", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"web\",\n \"origin\": \"string\",\n \"ttl_seconds\": 4412,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "05823248-12e3-4c74-b4e4-3afe3e3bb309", "name": "rentals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f60561e3-49af-4888-9af5-0081e22757e2", "name": "Published rental pickup locations (cities, airports, stations).", "request": { "name": "Published rental pickup locations (cities, airports, stations).", "description": { "content": "Cursor-paginated, ordered by type then name (matching the grouped, alphabetical-within-type order this endpoint has always used) — NOT by creation time. `q` matches against the location name in the requested `locale` (falling back to English).", "type": "text/plain" }, "url": { "path": [ "rentals", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "locale", "value": "string" }, { "disabled": false, "key": "country", "value": "st" }, { "disabled": false, "key": "types", "value": "string" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ee768781-a1b5-4ece-ac84-95bec470a0eb", "name": "Locations page.", "originalRequest": { "url": { "path": [ "rentals", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "country", "value": "st" }, { "key": "types", "value": "string" }, { "key": "q", "value": "string" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rows\": [\n {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n {\n \"key_0\": {},\n \"key_1\": {}\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61c3fc23-d8da-435c-9cc3-bb522f9dda5a", "name": "Invalid query.", "originalRequest": { "url": { "path": [ "rentals", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "country", "value": "st" }, { "key": "types", "value": "string" }, { "key": "q", "value": "string" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a959d2a-d5a7-4a56-ae6f-e5b53c75af3d", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "country", "value": "st" }, { "key": "types", "value": "string" }, { "key": "q", "value": "string" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c665c541-7f57-423c-9519-ec4a95c2cc51", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "country", "value": "st" }, { "key": "types", "value": "string" }, { "key": "q", "value": "string" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01e6d716-8338-48c3-b776-b0cefb87c4d5", "name": "Countries where car rentals are available.", "request": { "name": "Countries where car rentals are available.", "description": { "content": "The countries with at least one published pickup city. This is coverage, not a supply guarantee for any one search: whether a given location and stay actually has vehicles can only be known by running the search. Use GET /rentals/locations for the full location list within a country you already know is covered, and GET /rentals/availability to find out what is bookable there on your dates.", "type": "text/plain" }, "url": { "path": [ "rentals", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5b4b67e5-fde4-48f3-8738-bf8c4e95a744", "name": "Countries with at least one published pickup city.", "originalRequest": { "url": { "path": [ "rentals", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rows\": [\n {\n \"country_code\": \"ma\",\n \"city_count\": 7\n },\n {\n \"country_code\": \"ma\",\n \"city_count\": 7\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd298a13-6157-41ef-9956-d7b9ef0d1c49", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5230205e-2c2e-4e5c-9269-cc8b81a15af3", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2acee2c1-5d37-441e-b7f1-1d6b04a159f6", "name": "Could not load countries.", "originalRequest": { "url": { "path": [ "rentals", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10a47f5e-b3dc-46ff-ad9f-e72fe01d855d", "name": "A single published rental car, priced at the calling partner's own commercial terms.", "request": { "name": "A single published rental car, priced at the calling partner's own commercial terms.", "description": {}, "url": { "path": [ "rentals", "cars", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "locale", "value": "string" }, { "disabled": false, "key": "currency", "value": "str" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3639c099-025d-4fb4-9237-7996f1320c30", "name": "Car detail.", "originalRequest": { "url": { "path": [ "rentals", "cars", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff2be60a-68c1-4ee8-9dd8-c3d8aa9ac524", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "cars", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49263fe7-6c1d-471f-82db-2aac750faccc", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "cars", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9583f4f1-9f50-4a5b-8f67-1d5ef8b09621", "name": "Not found.", "originalRequest": { "url": { "path": [ "rentals", "cars", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "locale", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "711efe10-f5d8-431f-b957-7acf599664e6", "name": "Dated, priced, bookable rental availability — one call, one vehicle shape.", "request": { "name": "Dated, priced, bookable rental availability — one call, one vehicle shape.", "description": { "content": "THE ONE RENTAL SEARCH. Give a location (`location`, or `pickup_location` / `delivery_location`, which additionally pin the mode) and a stay (`date_from`, `date_to`, both required, `date_to` strictly after `date_from`), and every vehicle comes back with a REAL DATED TOTAL for that stay — not a per-day figure you have to multiply. `days` is reported ONCE at the top level: it is a property of the stay window and identical for every vehicle. `total` reflects duration tiers and date exceptions where the crew set them (`variable_pricing: true` says so), and follows a sale price when one is in effect — the same numbers POST /rentals/bookings will bill, so `total` is what belongs in the `expected_total` a booking asserts. EVERY VEHICLE HAS THE SAME SHAPE, and every vehicle is booked the same way: pass its `slug` back as `car_slug`. Fields that do not apply to a given vehicle (`location`, `fleet_size`, `vehicle_type`) are `null`, never omitted. POLLING: most searches are answered completely in this one call — `use_polling` is then `false` and `search_id`, `status`, `poll_after_ms` and `expires_at` are all `null`. Some searches need longer than one request allows; this endpoint waits for them briefly and answers the moment they finish. If one is still running when the response goes out, `use_polling` is `true` and `vehicles` may be empty — call THIS SAME URL again with `?search_id={search_id}` after `poll_after_ms`, and nothing else (dates and location are not needed on a poll), until `status` is `complete`. A `search_id` is also returned when the search DID finish in time, so you may poll it again for the same result until `expires_at`; `use_polling: false` tells you there is no need. `status` is pending | complete | failed | expired. `vehicle_type` accepts either the canonical prefixed slug (`vehicle-suv`) or the bare one (`suv`); the response always emits the canonical stored slug. A `search_id` belonging to another partner 404s, never 403s.", "type": "text/plain" }, "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "location", "value": "string" }, { "disabled": false, "key": "pickup_location", "value": "string" }, { "disabled": false, "key": "delivery_location", "value": "string" }, { "disabled": false, "key": "delivery_lat", "value": "33.5731" }, { "disabled": false, "key": "delivery_lng", "value": "-7.5898" }, { "disabled": false, "key": "date_from", "value": "2009-03-05" }, { "disabled": false, "key": "date_to", "value": "2009-03-05" }, { "disabled": false, "key": "age", "value": "49" }, { "disabled": false, "key": "vehicle_type", "value": "string" }, { "disabled": false, "key": "pickup_hour", "value": "9" }, { "disabled": false, "key": "return_hour", "value": "9" }, { "disabled": false, "key": "pickup_type", "value": "pickup" }, { "disabled": false, "key": "price_min", "value": "2011" }, { "disabled": false, "key": "price_max", "value": "2011" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "attrs", "value": "string" }, { "disabled": false, "key": "country", "value": "cj" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "12" }, { "disabled": false, "key": "locale", "value": "en" }, { "disabled": false, "key": "search_id", "value": "string" }, { "disabled": false, "key": "car_slug", "value": "string" }, { "disabled": false, "key": "currency", "value": "str" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f628190f-4a72-4f63-89f5-a339f9f020b8", "name": "Dated availability — vehicles, plus a search handle when one is still running.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"days\": 1792.7358756527879,\n \"date_from\": \"string\",\n \"date_to\": \"string\",\n \"vehicles\": [\n {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n {\n \"key_0\": {}\n }\n ],\n \"total\": 2256.927085007424,\n \"page\": 847.2655059891188,\n \"limit\": 3860.2855522098234,\n \"use_polling\": true,\n \"search_id\": \"string\",\n \"status\": \"complete\",\n \"poll_after_ms\": 7873.099206843142,\n \"expires_at\": \"string\",\n \"booking_mode\": \"variable\",\n \"hint\": \"string\",\n \"hint_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d0d87ce-848f-41f0-b7ac-d1ab0b6378c5", "name": "Missing/invalid dates or location.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba922b93-7aad-4c45-b846-bb4454f5ebf4", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5ad4e62-af68-45d3-bdfe-452138276d96", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fbfb47b8-0c9c-437e-a8c9-1014549e7830", "name": "No such `search_id`, or it belongs to another partner.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d756452-3eb4-4dfb-a9e6-d7a3108f470e", "name": "Availability lookup failed.", "originalRequest": { "url": { "path": [ "rentals", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location", "value": "string" }, { "key": "pickup_location", "value": "string" }, { "key": "delivery_location", "value": "string" }, { "key": "delivery_lat", "value": "33.5731" }, { "key": "delivery_lng", "value": "-7.5898" }, { "key": "date_from", "value": "2009-03-05" }, { "key": "date_to", "value": "2009-03-05" }, { "key": "age", "value": "49" }, { "key": "vehicle_type", "value": "string" }, { "key": "pickup_hour", "value": "9" }, { "key": "return_hour", "value": "9" }, { "key": "pickup_type", "value": "pickup" }, { "key": "price_min", "value": "2011" }, { "key": "price_max", "value": "2011" }, { "key": "q", "value": "string" }, { "key": "attrs", "value": "string" }, { "key": "country", "value": "cj" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "12" }, { "key": "locale", "value": "en" }, { "key": "search_id", "value": "string" }, { "key": "car_slug", "value": "string" }, { "key": "currency", "value": "str" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f2fe98b-2c36-4016-ad38-516d2f57fdf7", "name": "Create a rental reservation — a draft booking, NOT a held car.", "request": { "name": "Create a rental reservation — a draft booking, NOT a held car.", "description": { "content": "Creates a draft booking (`status: \"draft\"`) exactly like POST /rentals/bookings with `confirm:false`, under a name a partner integration expects for a two-step flow. A RESERVATION DOES NOT HOLD A CAR: it is a draft booking with the system's existing ~30-minute expiry, and another customer can still book the same car while this reservation exists — nothing about creating one removes the car from availability. Confirm it with POST /rentals/reservations/{reference}/book before it expires, or it is auto-cancelled. Pass back the `slug` the search gave you as `car_slug` — every vehicle reserves the same way, whatever served it. `expected_total` is optional here and re-checked, not required, at `book` time.", "type": "text/plain" }, "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb09af05-05c6-46eb-95d9-e5887913fc36", "name": "Reservation created (a draft booking).", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9eb605c-7484-43fd-9b53-efdb7bfdde34", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7f1607c-a472-4ead-a7f7-ea936a19d6e3", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e04b0654-7e39-4cf9-8f90-07e0dc8bca3d", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87ac47ce-105b-45c3-aef2-84dbca96ef7d", "name": "No such car, or it is not available to this partner.", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "915dbf7c-e794-409b-adc9-bea5280a9813", "name": "Unavailable, the search result has expired, or the vehicle is supplied by a crew your account is not set up to sell (`crew_not_included`).", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d05b685-e62b-48dd-b9a7-b8c89a51ef14", "name": "Reservation failed.", "originalRequest": { "url": { "path": [ "rentals", "reservations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1982-02-02\",\n \"date_to\": \"1971-07-06\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"OwwL9jyC@HVIm.ms\",\n \"phone\": \"string\"\n },\n \"units\": 1,\n \"pickup_hour\": 10,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"expected_total\": 257065.83222964453,\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80c67833-e031-438e-8f1d-adef26b4afc5", "name": "Confirm a reservation into a real, paid booking.", "request": { "name": "Confirm a reservation into a real, paid booking.", "description": { "content": "Authorizes payment on an existing draft reservation — the same confirm step POST /rentals/bookings runs internally, split out so a partner can reserve first and book later. Refuses (404) a reservation that does not belong to the caller, (409 `reservation_expired`) one past its ~30-minute draft window, and (409 `already_booked`) one that was already turned into a real booking — never creates a second booking for the same reservation. If `expected_total` is supplied it is checked against the reservation's actual total with the same cent-tolerance rule POST /rentals/bookings applies. EVERY reservation books exactly the same way, whatever vehicle it holds, and the response is the same shape in every case — see POST /rentals/bookings's own description for what the resulting booking status means and how to follow it to confirmation.", "type": "text/plain" }, "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba003058-3846-43d4-9be4-5ba26ee1d3e4", "name": "Booked.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e78fef91-c1f2-46f2-b469-e1c9c5347703", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8387526-d474-4f1a-9537-f104199e9567", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22413491-c0d0-44ea-bf47-3db359d9b913", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f9702d1-58f2-4302-9753-f58457caa25f", "name": "No such reservation, or it does not belong to this partner.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4693c11-dd68-4ba5-8ff8-4cf2511dc5b9", "name": "Expired, already booked, or a price mismatch.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f5eb1e-deb5-4fa3-9127-15925ffeafc1", "name": "Book failed.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"string\",\n \"expected_total\": 322377.4236506767,\n \"customer_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00c21db4-ebe5-4c93-bfdf-bb82645f6e1b", "name": "Cancel a reservation (a draft booking) — never a confirmed booking.", "request": { "name": "Cancel a reservation (a draft booking) — never a confirmed booking.", "description": { "content": "Drops a draft reservation nobody has paid for. Refuses a reservation that has already been turned into a real booking (409 `not_a_reservation`) — cancelling a booking with money attached is a different, deliberately separate operation: POST /v1/bookings/{reference}/cancel. Calling DELETE here on a confirmed/pending booking never cancels it silently.", "type": "text/plain" }, "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e9b4934a-2ac1-4ed0-bf5e-9c676573e0ee", "name": "Cancelled.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab71a2bf-1a3b-46a9-93f4-bb075e2a3a2e", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06237e0d-a85b-4a06-a3a2-defdda1d06de", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c83fd4df-248e-4ed9-a3b2-159e9a809add", "name": "No such reservation, or it does not belong to this partner.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4620cbf-4d0f-41d5-a845-365908b74c2d", "name": "Not a reservation (already booked) — use POST /v1/bookings/{reference}/cancel instead.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d121bba-b5c2-469a-80dd-4793646eee60", "name": "Cancel failed.", "originalRequest": { "url": { "path": [ "rentals", "reservations", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ec57df6-4c77-4e38-89e7-511f2e2b5f5b", "name": "Book a rental as merchant of record for the partner's own customer.", "request": { "name": "Book a rental as merchant of record for the partner's own customer.", "description": { "content": "Pass back the `slug` GET /rentals/availability gave you as `car_slug` — every vehicle books the same way, and you never branch on where it came from. Booked with the `expected_total` discipline described in this API's header: the total you already showed your customer, refused (409 `price_mismatch`) if the priced draft disagrees by more than a cent. A 201 MEANS THE ORDER IS PLACED WITH DRIVECARS, NOT THAT A CAR IS HELD. A new booking comes back in a not-yet-`confirmed` state, and there is no fixed SLA for when it becomes `confirmed`. TREAT ANY STATUS THAT IS NOT `confirmed` AS PENDING — more than one such status exists, they carry no obligation you need to act on differently, and new ones may be added without notice; branch on `confirmed` alone. Poll GET /v1/bookings/{reference} or subscribe to the booking webhook events; never infer confirmation from the absence of an error. A slug you were given more than an hour ago may no longer be priceable (409 `search_expired`) — search again and book from the fresh result, since a stale quote is never honoured. Not every vehicle can be delivered: `pickup_type: \"delivery\"` on one that must be collected in person is refused as `unavailable`.", "type": "text/plain" }, "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c02b85c-80e7-442d-aac3-8d2f0bdbd508", "name": "Booking created — not yet confirmed.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16722f40-ce9d-441a-bbc6-f854e5808e3d", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca8e172b-23bb-43d4-a6ea-5cc103dcc736", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ed126e7-dc39-4707-971e-7046c4aaec81", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5565c22-f80e-4cc7-8a2e-326548ec8731", "name": "No such car, or it is not available to this partner.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f99471a8-bdb2-45d1-ba0b-3e1bbfe0ee9d", "name": "Unavailable, price mismatch, the search result has expired, or the vehicle is supplied by a crew your account is not set up to sell (`crew_not_included`).", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6047ce57-6844-45a1-af6a-48f7aeac3872", "name": "Booking failed.", "originalRequest": { "url": { "path": [ "rentals", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A key you choose, unique per booking attempt. Replaying the SAME key returns the original response with `Idempotent-Replayed: true` instead of creating a second booking -- which is what makes a timed-out request safe to retry. Reusing a key with a DIFFERENT body is a 422.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"car_slug\": \"string\",\n \"date_from\": \"1957-07-15\",\n \"date_to\": \"2021-11-12\",\n \"customer\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"XdDki36bclcF@MaEJqYvFw.lx\",\n \"phone\": \"string\"\n },\n \"expected_total\": 944455.1798001964,\n \"payment_reference\": \"string\",\n \"units\": 1,\n \"pickup_hour\": 21,\n \"return_hour\": 18,\n \"pickup_type\": \"pickup\",\n \"pickup_location_slug\": \"string\",\n \"pickup_location_name\": \"string\",\n \"delivery_address\": \"12 Rue Test, Casablanca\",\n \"delivery_lat\": 33.5731,\n \"delivery_lng\": -7.5898,\n \"payment_method\": \"card\",\n \"currency\": \"str\",\n \"external_ref\": \"string\",\n \"customer_ref\": \"string\",\n \"confirm\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "de0d5a5f-9ee0-40f7-bb4c-f2d1d96ade26", "name": "bookings", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e479ef14-d4a6-48e9-8b6d-00efb235fca8", "name": "List the calling partner's own bookings.", "request": { "name": "List the calling partner's own bookings.", "description": { "content": "Fetch GET /v1/bookings/{reference} for a specific booking to get its driver name, vehicle and plate.", "type": "text/plain" }, "url": { "path": [ "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "product", "value": "car-rentals" }, { "disabled": false, "key": "status", "value": "draft" }, { "disabled": false, "key": "external_ref", "value": "string" }, { "disabled": false, "key": "created_after", "value": "1968-11-03T19:53:01.151Z" }, { "disabled": false, "key": "created_before", "value": "1968-11-03T19:53:01.151Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d2bab807-6276-44d2-b5a6-2e5d8bc18116", "name": "Bookings page.", "originalRequest": { "url": { "path": [ "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "value": "car-rentals" }, { "key": "status", "value": "draft" }, { "key": "external_ref", "value": "string" }, { "key": "created_after", "value": "1968-11-03T19:53:01.151Z" }, { "key": "created_before", "value": "1968-11-03T19:53:01.151Z" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"status\": \"string\",\n \"fulfilment\": {\n \"state\": \"reserved\",\n \"reference\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"fulfilment\": {\n \"state\": \"failed\",\n \"reference\": \"string\"\n }\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5e9c6d-3fb9-4f0e-8c47-49f380280061", "name": "Invalid query.", "originalRequest": { "url": { "path": [ "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "value": "car-rentals" }, { "key": "status", "value": "draft" }, { "key": "external_ref", "value": "string" }, { "key": "created_after", "value": "1968-11-03T19:53:01.151Z" }, { "key": "created_before", "value": "1968-11-03T19:53:01.151Z" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38ce5757-2d09-4e30-b419-7ab4b289e060", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "value": "car-rentals" }, { "key": "status", "value": "draft" }, { "key": "external_ref", "value": "string" }, { "key": "created_after", "value": "1968-11-03T19:53:01.151Z" }, { "key": "created_before", "value": "1968-11-03T19:53:01.151Z" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c85edb9-d81e-4c04-9e74-0aef9ce0c1f2", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "value": "car-rentals" }, { "key": "status", "value": "draft" }, { "key": "external_ref", "value": "string" }, { "key": "created_after", "value": "1968-11-03T19:53:01.151Z" }, { "key": "created_before", "value": "1968-11-03T19:53:01.151Z" }, { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "caa424d4-7bb9-4662-8b6f-539b60ef1420", "name": "A single booking, if it belongs to the calling partner.", "request": { "name": "A single booking, if it belongs to the calling partner.", "description": { "content": "A `201`/`200` from book means the order is placed with DriveCars and payment is authorized; poll this endpoint for the booking's current `status`, which is the single field that tells you where the order stands. BRANCH ON `confirmed` ALONE: more than one not-yet-confirmed status exists, they carry no obligation you need to act on differently, and new ones may be added without notice — treat every status that is not `confirmed` (and not `cancelled`) as still pending.", "type": "text/plain" }, "url": { "path": [ "bookings", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ba270518-1ef7-4be3-8bcc-2a0b33cf65a8", "name": "Booking detail.", "originalRequest": { "url": { "path": [ "bookings", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"fulfilment\": {\n \"state\": \"reserved\",\n \"reference\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f94e661a-cbda-47b1-93e1-dd699ab7e8fa", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "bookings", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3257943e-614b-462f-b7ab-fd9fd3ae2b28", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "bookings", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70d64ab4-1438-4376-8b94-9a179c676d7a", "name": "Not found.", "originalRequest": { "url": { "path": [ "bookings", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f2ce9c7-8c55-44a5-b70d-c7c48c263afc", "name": "A single booking looked up by the partner's own external_ref.", "request": { "name": "A single booking looked up by the partner's own external_ref.", "description": {}, "url": { "path": [ "bookings", "ext", ":external_ref" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_ref", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be3f67a2-813f-4786-a68c-832f8e5dc277", "name": "Booking detail.", "originalRequest": { "url": { "path": [ "bookings", "ext", ":external_ref" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_ref", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"fulfilment\": {\n \"state\": \"reserved\",\n \"reference\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f08ccaa8-0958-4df6-a14b-1c05e4e0a658", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "bookings", "ext", ":external_ref" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_ref", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fd005a6-d322-419a-b020-4af2ae55dff0", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "bookings", "ext", ":external_ref" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_ref", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a7bc354-13f8-4e22-a178-071f19883b43", "name": "Not found.", "originalRequest": { "url": { "path": [ "bookings", "ext", ":external_ref" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_ref", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d81df19-faf4-4251-8115-9db78e333210", "name": "Cancel one of the calling partner's own bookings.", "request": { "name": "Cancel one of the calling partner's own bookings.", "description": {}, "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7c5ae89a-556e-4894-8279-ad9a914d4c4a", "name": "Cancelled.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79a3710-535f-4220-9d74-78cea235fbe8", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7d9cdb9-d117-4423-9d91-c66c8240544d", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d76a43a-2e4e-476e-ae34-0fd72af51329", "name": "Not found.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abc75918-2c6f-4a41-9750-46b67409f8fc", "name": "Not cancellable.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fee1219e-3b1b-4c5b-bd1a-39f8735c7592", "name": "Cancel failed.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "338d41b9-46e0-434d-bfe9-7db2216d2695", "name": "Confirm, from your server, that you have taken payment for one of your own bookings.", "request": { "name": "Confirm, from your server, that you have taken payment for one of your own bookings.", "description": { "content": "Partner-MoR only. Call this from your backend once your PSP has authorised the charge for a booking created through the Web SDK. Until you do, the booking stays a draft: it is not confirmed, not fulfilled and not invoiced. The widget on the customer's page advances on its own once this call lands. Idempotent for the same payment_reference.", "type": "text/plain" }, "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "14bad759-3363-4ad9-8e99-44da0eade0b4", "name": "Payment recorded; the booking is now pending confirmation with the crew.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d8dc7a3-94f4-4fb1-b577-892bb71194d9", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4dbb7af-e273-4ab7-8b4b-18b553dcf163", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfaa0beb-21f2-4017-b4c5-88ef9f1ea07d", "name": "Not found.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ab963f-e378-47bf-819e-1872b6725969", "name": "Not a partner-invoiced booking, cancelled, or already confirmed with a different reference.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e0c861a-f7fc-44f7-96c6-3861456eb0f4", "name": "Confirmation failed.", "originalRequest": { "url": { "path": [ "bookings", ":reference", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "reference", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payment_reference\": \"ch_3P8k2Q…\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a5f4b3d7-01cd-46a5-9f98-e8cb993e1024", "name": "me", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fad1517f-1b1c-4a9b-b000-67be45600375", "name": "The calling partner's own profile and the scopes this token holds.", "request": { "name": "The calling partner's own profile and the scopes this token holds.", "description": {}, "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "374f6e99-9a95-4c71-9d2d-411533f97155", "name": "Partner profile.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 320.71318089403667,\n \"slug\": \"string\",\n \"name\": \"string\",\n \"status\": \"active\",\n \"mor_mode\": \"partner_invoiced\",\n \"scopes\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081d3764-b877-4023-bb05-2df25e0f95f6", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56c633ee-7ac3-42ff-88cd-cf63b60e0dd7", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "abbfd5c7-efb5-4fc4-b663-e3a0bb72fbb8", "name": "webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "051ff211-1951-4c93-a099-4d0f70363db8", "name": "List the calling partner's own webhook endpoints.", "request": { "name": "List the calling partner's own webhook endpoints.", "description": { "content": "Returns every endpoint for the caller in one page when `limit` is omitted. Pass `limit` (max 100) to page explicitly, then follow `next_cursor` the same way as GET /v1/bookings.", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "22" }, { "disabled": false, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "88c8590c-daa4-421a-aba1-7603399cc9c2", "name": "Webhook endpoints.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "22" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 7895.299829016724,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"active\",\n \"consecutive_failures\": 8203.903963397937,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"id\": 4602.8140882979715,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"active\",\n \"consecutive_failures\": 9026.57321542864,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed20ee7-8b77-4de8-acc6-33d850160697", "name": "Invalid query.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "22" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0ff6651-2cae-41e1-b450-4d01c37663aa", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "22" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6eae92c-5675-4994-8269-54f466dbdb9b", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "22" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "593ad382-5b50-4c59-bef9-9f1e8253873a", "name": "Register a new webhook endpoint.", "request": { "name": "Register a new webhook endpoint.", "description": {}, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4afb7256-62a5-45cc-803d-f7cf3ada78f6", "name": "Created. `secret` is returned ONCE, here — it is never included in any other response (list, get, or a later patch). Store it now.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1200.997952610895,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"disabled\",\n \"consecutive_failures\": 6361.144034284193,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32471b03-ec7a-4a3a-9749-d0a67a93d988", "name": "Invalid payload, or an unsafe url.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b8af227-2665-468c-9b31-8bc06bbf8909", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b72f59c9-78f6-4264-9f6b-94fecdba0ca5", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "365b4ae9-0eca-47c3-99e5-61ce57ff2ae4", "name": "A single webhook endpoint, if it belongs to the calling partner.", "request": { "name": "A single webhook endpoint, if it belongs to the calling partner.", "description": {}, "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3bc284bb-9c3f-44ca-9f25-6a828f359632", "name": "Endpoint.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 6096.014872263018,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"auto_disabled\",\n \"consecutive_failures\": 724.7587034223058,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a0c7185-c7e6-4fc3-befb-9deee3768462", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b97aaf5b-e356-4472-a907-1ad0932f99ef", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d4ce8d6-e2b5-469b-90f0-0aca4a83b387", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f1ca526-d345-4336-91c1-0ec5389ce307", "name": "Update a webhook endpoint.", "request": { "name": "Update a webhook endpoint.", "description": {}, "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ade2b6f7-bf07-4122-841e-6fc181c11ee0", "name": "Updated.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 6096.014872263018,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"auto_disabled\",\n \"consecutive_failures\": 724.7587034223058,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cb78a9a-48d7-4b8d-bb09-4c257e7865bd", "name": "Invalid payload, or an unsafe url.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cb222bb-79b4-4723-a433-63f001d9d681", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "735f2bdd-b5ed-46d8-a5e0-24f5170172da", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9b15742-af7c-4632-9f6d-d4faefceebbc", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7da8f09e-59b0-455c-8471-9030ee43ce40", "name": "Disable a webhook endpoint (soft delete — delivery history is preserved).", "request": { "name": "Disable a webhook endpoint (soft delete — delivery history is preserved).", "description": {}, "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b4ce6ec2-9a93-468e-9504-ed34bb9c7d11", "name": "Disabled.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f25fe66-b0a1-4b44-8ead-e49b7e33a13f", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e82b22ab-78a8-4da3-a4dc-269078caea96", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8581af61-5528-4ab7-bccc-88e14655aef1", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "626bd219-b1b7-47ba-87ae-8aaaedb49a35", "name": "Rotate the signing secret. The OLD secret keeps signing deliveries for an overlap window so a deploy of the new secret never drops a delivery.", "request": { "name": "Rotate the signing secret. The OLD secret keeps signing deliveries for an overlap window so a deploy of the new secret never drops a delivery.", "description": {}, "url": { "path": [ "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7698f4e1-9cb1-4f2b-ac96-19ef425cdc78", "name": "Rotated. `secret` is the NEW secret, returned ONCE, here.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1200.997952610895,\n \"url\": \"string\",\n \"description\": \"string\",\n \"event_types\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"disabled\",\n \"consecutive_failures\": 6361.144034284193,\n \"last_success_at\": \"string\",\n \"last_failure_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "294bdd84-8474-49f6-b961-727b303208a3", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b84cb720-9a9b-4339-afb1-a8e13f2efcde", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3106945d-1d40-4a8d-b043-9ee34d55203f", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24e3af02-fa9a-4d54-b872-16f4bac4914e", "name": "Send a `ping` event to this partner's active webhook endpoints.", "request": { "name": "Send a `ping` event to this partner's active webhook endpoints.", "description": {}, "url": { "path": [ "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cb4ef276-e923-453b-aaee-3bf767c926a1", "name": "Ping queued.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132ebab9-ab53-4bb6-b6b4-fe2db70488f0", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12ac5a71-f314-4d04-8def-5a17dd040af3", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2a0fe17-8bb9-4999-8145-5a78f1150dd6", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c763b7c9-2d69-4a8e-b7af-0fbd6104eb90", "name": "An endpoint's delivery history, newest first.", "request": { "name": "An endpoint's delivery history, newest first.", "description": {}, "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "32904892-4946-4083-be59-2bc9c8e67de2", "name": "Deliveries page.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 542.1844428195543,\n \"event_id\": \"string\",\n \"endpoint_id\": 2945.6261389072247,\n \"status\": \"string\",\n \"attempt\": 8228.870784045372,\n \"next_attempt_at\": \"string\",\n \"replay_of\": 606.3049839717627,\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"id\": 5111.149858810269,\n \"event_id\": \"string\",\n \"endpoint_id\": 9016.699146456325,\n \"status\": \"string\",\n \"attempt\": 4145.326551156767,\n \"next_attempt_at\": \"string\",\n \"replay_of\": 6468.948224958525,\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25cc5f5-4032-4a3c-8e76-ef146da79225", "name": "Invalid cursor.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c9e5a40-8c17-4306-8b73-77fe24b17050", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94406577-b9d1-40c5-9061-1c38f6e49cd7", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54dca444-2a59-4dde-82f6-6f8ccbba0ec8", "name": "Not found.", "originalRequest": { "url": { "path": [ "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "610108cd-c7f1-4b16-92ea-787a0bcff117", "name": "Replay a delivery as a fresh attempt lineage.", "request": { "name": "Replay a delivery as a fresh attempt lineage.", "description": {}, "url": { "path": [ "deliveries", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8ee0fa68-c2e8-4a31-8807-5c5499c228f8", "name": "Replay queued.", "originalRequest": { "url": { "path": [ "deliveries", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 920.8492287770042,\n \"event_id\": \"string\",\n \"endpoint_id\": 7029.373890496013,\n \"status\": \"string\",\n \"attempt\": 8309.316225353192,\n \"next_attempt_at\": \"string\",\n \"replay_of\": 1458.332138281776,\n \"attempts\": [],\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83324b38-b24b-49d7-b3ec-b36d4896e9ce", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "deliveries", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf4314de-39a9-4f0f-bfd3-6a6a3a7a27ac", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "deliveries", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ddac41bd-c0ca-4e10-9d22-db846758cedc", "name": "Not found.", "originalRequest": { "url": { "path": [ "deliveries", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4625", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "368aa2d3-2111-47fb-b2c0-d8be5c37e6fb", "name": "events", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "64cd18a7-89d0-4241-a6e1-abd26ee336a3", "name": "Poll the calling partner's own event outbox (the polling fallback to webhooks).", "request": { "name": "Poll the calling partner's own event outbox (the polling fallback to webhooks).", "description": { "content": "Events older than 90 days are not returned. `since_id` is the numeric `id` field of the last event you saw — NOT its `event_id` string — pass it back to page forward.", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since_id", "value": "2011" }, { "disabled": false, "key": "types", "value": "string" }, { "disabled": false, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "43f5457c-9d39-4a98-b430-a4af406e2b06", "name": "Events page, ordered oldest-to-newest by internal id.", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since_id", "value": "2011" }, { "key": "types", "value": "string" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"created_at\": \"string\",\n \"livemode\": false,\n \"data\": {}\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"created_at\": \"string\",\n \"livemode\": false,\n \"data\": {}\n }\n ],\n \"has_more\": true,\n \"last_id\": 7345.665956114183\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dfdc830-0460-4209-881c-6f4ffa5c93a0", "name": "Invalid `types`.", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since_id", "value": "2011" }, { "key": "types", "value": "string" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce3727a-e329-4bf0-b2ce-cb85c7343f9b", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since_id", "value": "2011" }, { "key": "types", "value": "string" }, { "key": "limit", "value": "50" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e61f062f-fac6-421f-87b5-db5589805a1b", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since_id", "value": "2011" }, { "key": "types", "value": "string" }, { "key": "limit", "value": "50" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a40c77c-ad8b-4124-afae-d6ade45087f2", "name": "A single event, if it belongs to the calling partner and is within the 90-day window.", "request": { "name": "A single event, if it belongs to the calling partner and is within the 90-day window.", "description": {}, "url": { "path": [ "events", ":event_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "event_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dbc1d764-7168-4551-ad9e-1a949766e732", "name": "Event.", "originalRequest": { "url": { "path": [ "events", ":event_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "event_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"type\": \"string\",\n \"created_at\": \"string\",\n \"livemode\": false,\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9ce5f20-3f76-42bd-b6fa-2562790c0d26", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "events", ":event_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "event_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6a01161-11b4-4a1a-96c3-0ff0202f9ef4", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "events", ":event_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "event_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "678f73f7-2fc9-46ee-9120-6c5ff577175f", "name": "Not found.", "originalRequest": { "url": { "path": [ "events", ":event_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "event_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2824732b-0727-4347-be0d-b2b064d2a74d", "name": "coverage", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "85fcf132-29e9-4a50-8c48-0c5689790154", "name": "Every country DriveCars serves, with per-product availability.", "request": { "name": "Every country DriveCars serves, with per-product availability.", "description": { "content": "`car_rentals.available` is true when the country has at least one published pickup city — the operator's own statement of \"we serve here\". It is COVERAGE, NOT A SUPPLY GUARANTEE for any one request: whether a particular location and stay actually has vehicles can only be known by calling GET /rentals/availability for it. A country missing a product key is not served for that product at all.", "type": "text/plain" }, "url": { "path": [ "coverage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49543a1a-a32c-424d-b546-1b51ef80b350", "name": "Countries with at least one available product.", "originalRequest": { "url": { "path": [ "coverage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"countries\": [\n {\n \"country_code\": \"ma\",\n \"name\": \"Morocco\",\n \"products\": {\n \"car_rentals\": {\n \"available\": true,\n \"locations\": 7910,\n \"airports\": 115\n }\n }\n },\n {\n \"country_code\": \"ma\",\n \"name\": \"Morocco\",\n \"products\": {\n \"car_rentals\": {\n \"available\": false,\n \"locations\": 141,\n \"airports\": 9155\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c202c26c-74a6-4253-b242-30a05c5fda57", "name": "No token or a malformed one (`unauthorized`, `invalid_token`). Note the wrong KIND of token is a 403 `wrong_token_type`, not a 401: /v1 requires an API access token from POST /oauth/token, and an SDK session token is refused as a permission problem rather than an authentication one.", "originalRequest": { "url": { "path": [ "coverage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dee057af-993c-406e-9738-8d31e347b3ce", "name": "Authenticated, but not permitted. `wrong_token_type`: an SDK session token was sent to a route that needs an API access token. `insufficient_scope`: the credential was issued without the scope this route needs -- a new credential fixes it. `product_not_enabled`: your account is not enabled for this product, which is a commercial setting rather than a bug, so contact your account manager instead of retrying. Note ownership answers 404, never 403.", "originalRequest": { "url": { "path": [ "coverage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "317c12ad-f51e-48cb-9398-770c0063a857", "name": "Could not load coverage.", "originalRequest": { "url": { "path": [ "coverage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b398ff02-6e0c-4fe5-8d47-a69dbe8bde76", "name": "Authentication", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c1cc0506-7956-4109-8eac-27add4888c9c", "name": "Exchange client credentials for an API access token", "request": { "name": "Exchange client credentials for an API access token", "description": { "content": "RFC 6749 §4.4 client-credentials grant. Present the client_id and client_secret issued to you, either as HTTP Basic auth or in the body. Returns a Bearer token valid for one hour, carrying the scopes granted to that credential. Every failure returns a uniform `invalid_client`, so the endpoint cannot be used to discover which client ids exist.", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "oauth", "token" ], "host": [ "{{host}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "grant_type", "value": "client_credentials", "description": "(Required) " }, { "disabled": false, "key": "client_id", "value": "dc_ci_0123456789abcdef01234567" }, { "disabled": false, "key": "client_secret", "value": "dc_cs_0123456789abcdef0123456789abcdef" }, { "disabled": false, "key": "scope", "value": "bookings:read", "description": "Optional, space-separated. Narrows the token to a subset of what the credential holds; it can never widen it. Omit for everything granted." } ] } }, "response": [ { "id": "5da32e85-2d1a-4410-9db2-27b02b8a2607", "name": "An access token.", "originalRequest": { "url": { "protocol": "https", "path": [ "oauth", "token" ], "host": [ "{{host}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "client_id", "value": "dc_ci_0123456789abcdef01234567" }, { "disabled": false, "key": "client_secret", "value": "dc_cs_0123456789abcdef0123456789abcdef" }, { "disabled": false, "description": { "content": "Optional, space-separated. Narrows the token to a subset of what the credential holds; it can never widen it. Omit for everything granted.", "type": "text/plain" }, "key": "scope", "value": "bookings:read" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"scope\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee8fe2ed-c6d2-4e1c-823f-4a2ce6c7441c", "name": "unsupported_grant_type, or invalid_scope.", "originalRequest": { "url": { "protocol": "https", "path": [ "oauth", "token" ], "host": [ "{{host}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "client_id", "value": "dc_ci_0123456789abcdef01234567" }, { "disabled": false, "key": "client_secret", "value": "dc_cs_0123456789abcdef0123456789abcdef" }, { "disabled": false, "description": { "content": "Optional, space-separated. Narrows the token to a subset of what the credential holds; it can never widen it. Omit for everything granted.", "type": "text/plain" }, "key": "scope", "value": "bookings:read" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44c2021b-a069-4bfc-81b5-94fe5badc94c", "name": "invalid_client — uniform for every credential failure.", "originalRequest": { "url": { "protocol": "https", "path": [ "oauth", "token" ], "host": [ "{{host}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "client_id", "value": "dc_ci_0123456789abcdef01234567" }, { "disabled": false, "key": "client_secret", "value": "dc_cs_0123456789abcdef0123456789abcdef" }, { "disabled": false, "description": { "content": "Optional, space-separated. Narrows the token to a subset of what the credential holds; it can never widen it. Omit for everything granted.", "type": "text/plain" }, "key": "scope", "value": "bookings:read" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39d606db-1fb2-46b0-950a-17bd2a356236", "name": "temporarily_unavailable — PARTNER_TOKEN_SECRET is not configured in this environment, so no verifiable token can be issued.", "originalRequest": { "url": { "protocol": "https", "path": [ "oauth", "token" ], "host": [ "{{host}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "client_id", "value": "dc_ci_0123456789abcdef01234567" }, { "disabled": false, "key": "client_secret", "value": "dc_cs_0123456789abcdef0123456789abcdef" }, { "disabled": false, "description": { "content": "Optional, space-separated. Narrows the token to a subset of what the credential holds; it can never widen it. Omit for everything granted.", "type": "text/plain" }, "key": "scope", "value": "bookings:read" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "host", "value": "your-base-url", "type": "string", "description": "Issued to you at onboarding (sandbox first, production at go-live)." }, { "key": "baseUrl", "value": "https://{{host}}/v1", "type": "string", "description": "Derived from host; leave as is." }, { "key": "bearerToken", "value": "", "type": "string", "description": "An access token from POST /oauth/token. Tokens last an hour." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "_postman_id": "ab0ec735-339b-4dc5-9e1e-3ebf716ca84b", "name": "DriveCars Partner API - Car rentals", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "DriveCars Partner API - Car rentals. Set the collection variable host to the base URL you were issued at onboarding and bearerToken to an access token from POST /oauth/token; every request inherits both." } }