{"info":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","description":"

The ShuttleControl Open API is organized around REST. Our Open API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Replace {{hostname}} with https://api.shuttlecontrol.com and {{apiKey}} with the API Key found under your in-app Company tab when using the Open API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2834192","collectionId":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","publishedId":"2s93JrvQC4","public":true,"customColor":{"top-bar":"0d6efd","right-sidebar":"303030","highlight":"0D6EFD"},"publishDate":"2023-03-13T19:29:23.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"fb2796a4-a340-444f-a209-8d9113a2f277","exec":["const json = pm.response.json()","","pm.environment.set(\"token\", json.token)","pm.environment.set(\"userId\", json.me.id)","pm.environment.set(\"storeId\", json.me.stores[0].id)","pm.environment.set(\"placeId\", json.me.stores[0].place.id)",""],"type":"text/javascript","packages":{}}}],"id":"8ce06119-983e-4508-b166-98eefded57d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"{{adminEmail}}\",\n \"password\": \"{{adminPassword}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/auth/login","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","auth","login"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ce06119-983e-4508-b166-98eefded57d3"}],"id":"6b10e36c-e8e0-4056-98bf-1e516188b931","_postman_id":"6b10e36c-e8e0-4056-98bf-1e516188b931","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Accounts","item":[{"name":"Get Account","id":"8449c2e7-c96b-42a9-918b-e8e96cbde29d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/accounts/me","description":"

This endpoint fetches details of the account, providing essential information such as the company's name, contact details, subscription status, and other relevant account information.

Exclusively accessible by the owner of the account, this endpoint allows for the modification of the company's account details.

Accessible only by users within the account who hold the BILLING role, this endpoint provides a direct link to the client company's Stripe billing portal. It returns an object with a url property, facilitating a straightforward path for managing the company's billing information, subscription plans, and payment methods via Stripe.

The Accounts folder contains endpoints related to user account management and billing information. Through these endpoints, developers can retrieve detailed account profiles, manage account settings, and access billing portals. This suite of APIs is designed to simplify user account integration, offering streamlined access to critical information and actions that enhance user experience.

\n","_postman_id":"200f1902-71ac-4e84-86cb-e43abec7ffd3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Users","item":[{"name":"Create User","id":"d2acabfd-c8bc-41fe-893c-ab8a96380a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"noah.sky@shuttlecontrol.com\",\n \"role\": \"DISPATCHER\",\n \"language\": \"en\",\n \"firstName\": \"Noah\",\n \"lastName\": \"Sky\",\n \"phoneNumber\": \"555 123 1234\",\n \"storeIds\": [\n \"{{storeId}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/users","description":"

Create a new user account with necessary details such as name, email, role, and other relevant information. The body of the request should include all required user fields.

Retrieve a list of all user accounts in the system. This endpoint supports pagination and filtering parameters to manage large sets of users.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","users"],"host":["{{hostname}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"3"}],"variable":[]}},"response":[{"id":"45f6c71c-7ab7-41bf-bdb8-b65c56d94fb0","name":"List Users response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/users?page=0&size=3","host":["{{hostname}}"],"path":["v2","users"],"query":[{"key":"page","value":"0"},{"key":"size","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"role\": \"OWNER\",\n \"enabled\": true,\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"phoneNumber\": \"514 699 7622\",\n \"email\": \"edward+owner@shuttlecontrol.com\",\n \"emailVerified\": false,\n \"language\": \"en\",\n \"loginToken\": \"cd1cbb48-3f1f-4ef7-83d0-45792be2b167\",\n \"createdAt\": \"2023-03-13T18:05:39.254Z\",\n \"account\": {\n \"id\": \"a9d32a39-86e0-4c8f-a69e-6aa2a56f2ac8\",\n \"enabled\": true,\n \"name\": \"ACME Inc.\",\n \"plan\": \"FLEET\",\n \"uom\": \"METRIC\",\n \"createdAt\": \"2023-03-13T18:05:39.247Z\",\n \"country\": \"CA\",\n \"trialEndAt\": \"2023-03-27T18:05:39.247Z\",\n \"integrations\": []\n },\n \"stores\": [\n {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"c60c1e2c-e3af-4e6b-8917-45023225488f\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"address\": \"Saint Joseph's Oratory of Mount Royal\"\n }\n },\n {\n \"id\": \"14142b60-0eec-49e5-b7ee-afd0c0b1e8d7\",\n \"name\": \"Bravo Store\",\n \"color\": \"blue\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"4c796a4e-8e8d-4044-9463-ea9d2803f3c9\",\n \"latitude\": 45.4651629,\n \"longitude\": -73.5756481,\n \"address\": \"3901 Bannantyne Ave, Verdun, QC H4G 1B9\"\n }\n }\n ],\n \"lastLoginAt\": \"2023-03-15T19:13:10.251Z\",\n \"createdBy\": null,\n \"updatedAt\": null,\n \"updatedBy\": null,\n \"vehicle\": null\n },\n {\n \"id\": \"c6b688ba-03e3-435c-a4dc-2b967f8ec0cf\",\n \"role\": \"DRIVER\",\n \"enabled\": true,\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"phoneNumber\": \"514 699 7622\",\n \"email\": \"edward+driver@shuttlecontrol.com\",\n \"emailVerified\": false,\n \"language\": \"en\",\n \"loginToken\": \"7f744b00-ffad-4efa-a6dd-e75470c3c32f\",\n \"createdAt\": \"2023-03-13T18:05:39.648Z\",\n \"account\": {\n \"id\": \"a9d32a39-86e0-4c8f-a69e-6aa2a56f2ac8\",\n \"enabled\": true,\n \"name\": \"ACME Inc.\",\n \"plan\": \"FLEET\",\n \"uom\": \"METRIC\",\n \"createdAt\": \"2023-03-13T18:05:39.247Z\",\n \"country\": \"CA\",\n \"trialEndAt\": \"2023-03-27T18:05:39.247Z\",\n \"integrations\": []\n },\n \"stores\": [\n {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"c60c1e2c-e3af-4e6b-8917-45023225488f\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"address\": \"Saint Joseph's Oratory of Mount Royal\"\n }\n },\n {\n \"id\": \"14142b60-0eec-49e5-b7ee-afd0c0b1e8d7\",\n \"name\": \"Bravo Store\",\n \"color\": \"blue\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"4c796a4e-8e8d-4044-9463-ea9d2803f3c9\",\n \"latitude\": 45.4651629,\n \"longitude\": -73.5756481,\n \"address\": \"3901 Bannantyne Ave, Verdun, QC H4G 1B9\"\n }\n }\n ],\n \"lastLoginAt\": null,\n \"createdBy\": null,\n \"updatedAt\": null,\n \"updatedBy\": null,\n \"vehicle\": null\n },\n {\n \"id\": \"515e4f0e-fc7a-4484-a1f9-cc7ed568eb76\",\n \"role\": \"DISPATCHER\",\n \"enabled\": true,\n \"firstName\": \"Jamie\",\n \"lastName\": \"Sky\",\n \"phoneNumber\": \"555 543 4321\",\n \"email\": \"jamie.sky@shuttlecontrol.com\",\n \"emailVerified\": false,\n \"language\": \"fr\",\n \"loginToken\": \"229bf334-e845-4ca8-8a0e-c5356bacee41\",\n \"createdAt\": \"2023-03-16T18:29:14.344Z\",\n \"account\": {\n \"id\": \"a9d32a39-86e0-4c8f-a69e-6aa2a56f2ac8\",\n \"enabled\": true,\n \"name\": \"ACME Inc.\",\n \"plan\": \"FLEET\",\n \"uom\": \"METRIC\",\n \"createdAt\": \"2023-03-13T18:05:39.247Z\",\n \"country\": \"CA\",\n \"trialEndAt\": \"2023-03-27T18:05:39.247Z\",\n \"integrations\": []\n },\n \"stores\": [\n {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"c60c1e2c-e3af-4e6b-8917-45023225488f\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"address\": \"Saint Joseph's Oratory of Mount Royal\"\n }\n }\n ],\n \"lastLoginAt\": null,\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": \"2023-03-16T18:53:43.625Z\",\n \"updatedBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"vehicle\": null\n }\n ],\n \"count\": 9\n}"}],"_postman_id":"9353e1b2-a772-442d-98e9-4ec9f029edb4"},{"name":"Get User","id":"7dffb96c-5f0f-4aa0-80d8-4a3b52c2be10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/users/{{userId}}","description":"

Fetch details of a specific user by their unique identifier. This is useful for retrieving the profile information and permissions of a user.

Update existing user information. This request should be used to modify user details such as name, email, or role.

Allows for the updating of a user’s password. This endpoint is protected and only accessible by users with the appropriate permissions.

Deactivate a user account, effectively disabling the user from accessing the system. The account remains in the database but is marked as inactive.

Reactivate a previously deactivated user account, restoring their access to the system.

This section of the API handles all operations related to user accounts within ShuttleControl. It allows for creating, retrieving, updating, and managing user account lifecycle.

\n","_postman_id":"3e4d4104-045e-4e8a-a772-f2b4a844b3e7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Trips","item":[{"name":"Create Trip","id":"4544d512-e7be-4850-b691-301e47c9ca78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"storeId\": \"{{storeId}}\",\n \"workflowId\": \"{{workflowId}}\",\n \"state\": \"REQUESTED\",\n \"language\": \"en\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"phoneNumber\": \"555 543 6543\",\n \"seats\": 2,\n \"steps\": [{\n \"name\": \"Point A\",\n \"type\": \"place\",\n \"position\": 1,\n \"place\": {\n \"address\": \"1255 Phillips Square, Montréal, QC H3B 3G1\"\n }\n }, {\n \"name\": \"Point B\",\n \"type\": \"place\",\n \"position\": 2,\n \"place\": {\n \"address\": \"3901 Rue Bannantyne, Verdun, H4G 1C2\"\n }\n }]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/trips","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","trips"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"f5e4b86b-8510-458a-998c-601fcf683a32","name":"Create Trip","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"storeId\": \"{{storeId}}\",\n \"workflowId\": \"{{workflowId}}\",\n \"state\": \"REQUESTED\",\n \"language\": \"en\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"phoneNumber\": \"555 543 6543\",\n \"seats\": 2,\n \"steps\": [{\n \"name\": \"Point A\",\n \"type\": \"place\",\n \"position\": 1,\n \"place\": {\n \"address\": \"1255 Phillips Square, Montréal, QC H3B 3G1\"\n }\n }, {\n \"name\": \"Point B\",\n \"type\": \"place\",\n \"position\": 2,\n \"place\": {\n \"address\": \"3901 Rue Bannantyne, Verdun, H4G 1C2\"\n }\n }]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/trips"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 20 Feb 2025 21:35:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Location","value":"https://api.shuttlecontrol.com/v2/trips/390d5507-40cc-4b8c-9132-c3eee0610370"},{"key":"ETag","value":"W/\"baa-DxTukqlQHMD7fpnyWP5cf3dAEoA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"390d5507-40cc-4b8c-9132-c3eee0610370\",\n \"state\": \"REQUESTED\",\n \"position\": 1,\n \"seats\": 2,\n \"reference\": \"\",\n \"scheduledAt\": null,\n \"requestedAt\": \"2025-02-20T21:35:37.476Z\",\n \"createdAt\": \"2025-02-20T21:35:37.476Z\",\n \"confirmedAt\": null,\n \"finishedAt\": null,\n \"customer\": {\n \"id\": \"1879e5a6-e0da-4442-b754-eb615dd72672\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"companyName\": \"\",\n \"phoneNumber\": \"555 543 6543\",\n \"email\": \"\",\n \"language\": \"en\"\n },\n \"secondaryCustomer\": null,\n \"customerReview\": null,\n \"workflow\": {\n \"id\": \"7e1e615e-ae7a-42df-abb8-d08aa18b696d\",\n \"name\": \"Shuttle Drop-off\",\n \"enableScheduledTripSms\": true,\n \"customerReviewsEnabled\": true,\n \"schedulerStepSize\": 15,\n \"defaultReturnTripWorkflow\": {\n \"id\": \"f7da5112-a01c-4ebd-b20c-d9a6561cf9db\",\n \"name\": \"Shuttle Pickup\"\n },\n \"companyNameRequired\": false,\n \"phoneNumberRequired\": true,\n \"customerRequired\": true\n },\n \"store\": {\n \"id\": \"5b1cc486-1382-4dfd-9e65-b2fbdddf39df\",\n \"name\": \"ShuttleControl\",\n \"place\": {\n \"id\": \"53169fee-7fe9-416e-90ff-e4cb0e64bbb3\",\n \"address\": \"General Urquiza, Buenos Aires, Argentina\",\n \"latitude\": -34.5703983,\n \"longitude\": -58.49138680000001,\n \"isFavorite\": true\n },\n \"storeBusinessHours\": {\n \"sundayStartAt\": null,\n \"sundayEndAt\": null,\n \"mondayStartAt\": \"2024-10-30T12:00:00.397Z\",\n \"mondayEndAt\": \"2024-10-30T20:00:00.160Z\",\n \"tuesdayStartAt\": \"2024-10-30T12:00:00.401Z\",\n \"tuesdayEndAt\": \"2024-10-30T20:00:00.316Z\",\n \"wednesdayStartAt\": \"2024-10-30T12:00:00.588Z\",\n \"wednesdayEndAt\": \"2024-10-30T20:00:00.780Z\",\n \"thursdayStartAt\": \"2024-10-30T12:00:00.926Z\",\n \"thursdayEndAt\": \"2024-10-30T20:00:00.042Z\",\n \"fridayStartAt\": \"2024-10-30T06:00:00.494Z\",\n \"fridayEndAt\": \"2024-10-31T02:00:00.318Z\",\n \"saturdayStartAt\": null,\n \"saturdayEndAt\": null\n }\n },\n \"steps\": [\n {\n \"id\": \"9c10cdd8-84f8-4923-8837-0c57e8dde62e\",\n \"name\": \"Point A\",\n \"type\": \"place\",\n \"position\": 1,\n \"imageUrl\": null,\n \"videoUrl\": null,\n \"place\": {\n \"id\": \"20d7962f-9069-47e7-9472-a253738a68a6\",\n \"address\": \"1255 Phillips Square, Montréal, QC H3B 3G1\",\n \"latitude\": 45.5041764,\n \"longitude\": -73.56834049999999,\n \"isFavorite\": false\n },\n \"driver\": null,\n \"vehicle\": null,\n \"finishedAt\": null,\n \"vehicleCoordinate\": null\n },\n {\n \"id\": \"5a920c88-efe9-4d7a-b2ce-6d39b7bfbf8b\",\n \"name\": \"Point B\",\n \"type\": \"place\",\n \"position\": 2,\n \"imageUrl\": null,\n \"videoUrl\": null,\n \"place\": {\n \"id\": \"aaa26e45-a3f9-4f93-8ab2-d4a0eb392e17\",\n \"address\": \"3901 Rue Bannantyne, Verdun, H4G 1C2\",\n \"latitude\": 45.465069,\n \"longitude\": -73.575825,\n \"isFavorite\": false\n },\n \"driver\": null,\n \"vehicle\": null,\n \"finishedAt\": null,\n \"vehicleCoordinate\": null\n }\n ],\n \"notes\": [],\n \"returnTrip\": null,\n \"returnTripFor\": null,\n \"createdBy\": {\n \"id\": \"68eb270f-67b4-49c3-811b-03257c43b4aa\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"phoneNumber\": \"514 699 7622\"\n },\n \"finishedBy\": null,\n \"drivers\": [\n {\n \"id\": \"0d6f6bcf-1eca-4e89-b128-0bc59404d16e\",\n \"firstName\": \"Jennifer\",\n \"lastName\": \"Parker\",\n \"fcmToken\": \"dgibJGoTxkMRqTHMDsvD8j:APA91bGLCY9FxrnwRWoRU5r8GpeKRu5EVrtdlEelxc9jq5kWgQ0pA1r7ugm2VmeobepkinHirSY3iUs7p70i9TbTmspii3miQ85gvXY9ok0InBhs6TFFMlA\",\n \"language\": \"fr\",\n \"phoneNumber\": \"\"\n }\n ],\n \"vehicle\": null,\n \"confirmedBy\": null,\n \"predictedDistance\": 8515.3,\n \"actualDistance\": null,\n \"predictedDuration\": 970.7,\n \"geometry\": null,\n \"zone\": null,\n \"stateEvents\": []\n}"}],"_postman_id":"4544d512-e7be-4850-b691-301e47c9ca78"},{"name":"Get Trip","id":"72fb2539-e200-4f07-a7f7-1c93e22298d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/{{tripId}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","trips","{{tripId}}"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"8005aca0-ada6-4a16-9bfd-324e90347a2d","name":"Get Trip response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/{{tripId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"eca054a0-174d-4ee1-a363-e9a9315adf5b\",\n \"seats\": 2,\n \"state\": \"REQUESTED\",\n \"reference\": \"\",\n \"customer\": {\n \"id\": \"dc697ec3-18ef-4479-8670-154b0a4a776a\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"phoneNumber\": \"555 543 6543\",\n \"companyName\": \"\",\n \"email\": \"\",\n \"language\": \"en\"\n },\n \"workflow\": {\n \"id\": \"117c7103-275e-4a18-ba2a-0556331fc408\",\n \"name\": \"Shuttle Pickup\",\n \"defaultReturnTripWorkflow\": null\n },\n \"scheduledAt\": null,\n \"drivers\": [],\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\",\n \"place\": {\n \"id\": \"c60c1e2c-e3af-4e6b-8917-45023225488f\",\n \"address\": \"Saint Joseph's Oratory of Mount Royal\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"isFavorite\": true\n }\n },\n \"notes\": [],\n \"steps\": [\n {\n \"id\": \"6a52bc3a-d2c3-4794-8d08-3632930779af\",\n \"type\": \"place\",\n \"place\": {\n \"id\": \"3cf70dd9-7c01-41df-8cbc-c6933565a70b\",\n \"address\": \"1255 Phillips Square, Montréal, QC H3B 3G1\",\n \"latitude\": 45.5041764,\n \"longitude\": -73.56834049999999,\n \"isFavorite\": false\n },\n \"position\": 1,\n \"name\": \"Point A\",\n \"finishedAt\": null,\n \"imageUrl\": null,\n \"driver\": null,\n \"vehicle\": null\n },\n {\n \"id\": \"044f137e-0a1f-49b8-bb36-247377c55dbe\",\n \"type\": \"place\",\n \"place\": {\n \"id\": \"d2ac439a-1aa0-4edb-b889-2ecccb6c42c8\",\n \"address\": \"3901 Rue Bannantyne, Verdun, H4G 1C2\",\n \"latitude\": 45.4651011,\n \"longitude\": -73.5759264,\n \"isFavorite\": false\n },\n \"position\": 2,\n \"name\": \"Point B\",\n \"finishedAt\": null,\n \"imageUrl\": null,\n \"driver\": null,\n \"vehicle\": null\n }\n ],\n \"createdAt\": \"2023-03-14T18:47:36.377Z\",\n \"confirmedAt\": null,\n \"confirmedBy\": null,\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"phoneNumber\": \"514 699 7622\"\n },\n \"finishedAt\": null,\n \"finishedBy\": null,\n \"updatedBy\": null,\n \"vehicle\": null,\n \"geometry\": null,\n \"predictedDistance\": 8507,\n \"predictedDuration\": 912,\n \"actualDistance\": null\n}"}],"_postman_id":"72fb2539-e200-4f07-a7f7-1c93e22298d9"},{"name":"List Trips History","id":"4b5bfac7-c530-4335-8184-9bad4f08c016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/history?startDate=2023-03-17T15:22:20.469Z&endDate=2023-03-20T15:33:20.469Z&page=0&size=5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","trips","history"],"host":["{{hostname}}"],"query":[{"key":"startDate","value":"2023-03-17T15:22:20.469Z"},{"key":"endDate","value":"2023-03-20T15:33:20.469Z"},{"key":"page","value":"0"},{"key":"size","value":"5"}],"variable":[]}},"response":[{"id":"7cafc6d3-a5a6-4da8-bd94-7d83a6ce1743","name":"List Trips History response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/trips/history?startDate=2023-03-17T15:22:20.469Z&endDate=2023-03-20T15:33:20.469Z&page=0&size=5","host":["{{hostname}}"],"path":["v2","trips","history"],"query":[{"key":"startDate","value":"2023-03-17T15:22:20.469Z"},{"key":"endDate","value":"2023-03-20T15:33:20.469Z"},{"key":"page","value":"0"},{"key":"size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"eca054a0-174d-4ee1-a363-e9a9315adf5b\",\n \"state\": \"COMPLETED\",\n \"position\": 1,\n \"seats\": 2,\n \"reference\": \"\",\n \"scheduledAt\": null,\n \"requestedAt\": \"2023-03-14T18:47:36.377Z\",\n \"createdAt\": \"2023-03-14T18:47:36.377Z\",\n \"confirmedAt\": null,\n \"finishedAt\": \"2023-03-20T15:32:54.461Z\",\n \"customer\": {\n \"id\": \"dc697ec3-18ef-4479-8670-154b0a4a776a\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"companyName\": \"\",\n \"phoneNumber\": \"555 543 6543\",\n \"email\": \"\",\n \"language\": \"en\"\n },\n \"customerReview\": {\n \"id\": \"a60f3fa6-70b2-4ca6-b349-169ef73dc38a\",\n \"rating\": 4.5,\n \"comment\": \"Thank you for such a wonderful shuttle experience!\",\n \"createdAt\": \"2023-03-16T15:02:21.435Z\"\n },\n \"workflow\": {\n \"id\": \"117c7103-275e-4a18-ba2a-0556331fc408\",\n \"name\": \"Shuttle Pickup\",\n \"enableScheduledTripSms\": true,\n \"customerReviewsEnabled\": true\n },\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\",\n \"place\": {\n \"id\": \"c60c1e2c-e3af-4e6b-8917-45023225488f\",\n \"address\": \"Saint Joseph's Oratory of Mount Royal\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"isFavorite\": true\n }\n },\n \"steps\": [\n {\n \"id\": \"6a52bc3a-d2c3-4794-8d08-3632930779af\",\n \"type\": \"place\",\n \"position\": 1,\n \"imageUrl\": null,\n \"place\": {\n \"id\": \"3cf70dd9-7c01-41df-8cbc-c6933565a70b\",\n \"address\": \"1255 Phillips Square, Montréal, QC H3B 3G1\",\n \"latitude\": 45.5041764,\n \"longitude\": -73.56834049999999,\n \"isFavorite\": false\n },\n \"finishedAt\": null,\n \"name\": \"Point A\"\n },\n {\n \"id\": \"044f137e-0a1f-49b8-bb36-247377c55dbe\",\n \"type\": \"place\",\n \"position\": 2,\n \"imageUrl\": null,\n \"place\": {\n \"id\": \"d2ac439a-1aa0-4edb-b889-2ecccb6c42c8\",\n \"address\": \"3901 Rue Bannantyne, Verdun, H4G 1C2\",\n \"latitude\": 45.4651011,\n \"longitude\": -73.5759264,\n \"isFavorite\": false\n },\n \"finishedAt\": null,\n \"name\": \"Point B\"\n }\n ],\n \"notes\": [],\n \"returnTrip\": null,\n \"returnTripFor\": null,\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"phoneNumber\": \"514 699 7622\"\n },\n \"drivers\": [],\n \"vehicle\": null,\n \"confirmedBy\": null,\n \"predictedDistance\": 8507,\n \"actualDistance\": null,\n \"predictedDuration\": 912,\n \"zone\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"4b5bfac7-c530-4335-8184-9bad4f08c016"}],"id":"32f4ba63-e93a-4ffc-b284-afb8923d8080","_postman_id":"32f4ba63-e93a-4ffc-b284-afb8923d8080","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Workflows","item":[{"name":"Create Workflow","id":"07e4f477-7642-4919-9036-0696fbd20ffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"storeId\": \"{{storeId}}\",\n \"name\": \"Shuttle Pickup\",\n \"description\": \"To bring the customer to the store.\",\n \"customerRequired\": true,\n \"emailRequired\": false,\n \"companyNameRequired\": false,\n \"enableScheduledTripSms\": true,\n \"customerReviewsEnabled\": false,\n \"phoneNumberRequired\": true,\n \"tripOptimizationHeuristic\": \"MINIMIZE_DURATION\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/workflows","description":"

Use this endpoint to create a new workflow. Provide the necessary details in the request body, such as any prerequisites, and the type of workflow (pickup, delivery, etc.). A successful request will return the details of the created workflow, including its unique identifier.

Retrieve a paginated list of workflows. This endpoint allows you to request a subset of workflows, which is useful for handling large datasets. You can specify pagination parameters such as page number and page size to navigate through the list.

Request the details of a specific workflow by providing the workflow's unique identifier. This endpoint fetches all the information associated with a workflow, including its steps, and type.

Update an existing workflow by providing its unique identifier along with the updated details in the request body.

Remove a workflow from the system using its unique identifier. This action disables the workflow so that it cannot be used to create a trip.

Obtain a comprehensive list of all workflows without pagination. This endpoint is suitable for systems that need to fetch all workflows in a single request, typically for synchronization or when working with a smaller set of data.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}},"urlObject":{"path":["v2","workflows"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"063a34c1-fcc7-4f03-9792-ecb02e0a86ca","name":"List All Workflows response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/workflows"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"1081-lGYexp0wPPrLQT16mMWXhxEBgIU\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 02 Apr 2024 17:39:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\",\n \"workflows\": [\n {\n \"id\": \"f3cb7fdf-9802-491c-bb5c-2e1d55520524\",\n \"name\": \"Shuttle Drop-off\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"32bf654e-ce9b-49a2-a11b-f58e266559cc\",\n \"name\": \"Shuttle Pickup\"\n },\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.376Z\"\n },\n {\n \"id\": \"32bf654e-ce9b-49a2-a11b-f58e266559cc\",\n \"name\": \"Shuttle Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"f3cb7fdf-9802-491c-bb5c-2e1d55520524\",\n \"name\": \"Shuttle Drop-off\"\n },\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.420Z\"\n },\n {\n \"id\": \"9ef2ebc1-ec03-4802-ad94-eb0d389b033c\",\n \"name\": \"Part Delivery\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.449Z\"\n },\n {\n \"id\": \"2db32e36-38c4-415b-888a-5e6732732b82\",\n \"name\": \"Part Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.470Z\"\n },\n {\n \"id\": \"cba24cf8-fa71-4bb7-b344-dc31f0d0cae7\",\n \"name\": \"Valet Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"d9416fde-d95c-4ce0-b469-f14b327a9ff2\",\n \"name\": \"Valet Drop-off\"\n },\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.487Z\"\n },\n {\n \"id\": \"d9416fde-d95c-4ce0-b469-f14b327a9ff2\",\n \"name\": \"Valet Drop-off\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"cba24cf8-fa71-4bb7-b344-dc31f0d0cae7\",\n \"name\": \"Valet Pickup\"\n },\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.509Z\"\n },\n {\n \"id\": \"b77fee16-89e8-4c97-a560-920aa637b13c\",\n \"name\": \"Task\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.534Z\"\n }\n ]\n },\n {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\",\n \"workflows\": [\n {\n \"id\": \"a205af77-9195-451e-b3ce-f22c5d5016de\",\n \"name\": \"Shuttle Drop-off\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"b3b18080-37f9-4e88-a1fd-2d975d0fdae1\",\n \"name\": \"Shuttle Pickup\"\n },\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.564Z\"\n },\n {\n \"id\": \"b3b18080-37f9-4e88-a1fd-2d975d0fdae1\",\n \"name\": \"Shuttle Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"a205af77-9195-451e-b3ce-f22c5d5016de\",\n \"name\": \"Shuttle Drop-off\"\n },\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.585Z\"\n },\n {\n \"id\": \"667de300-da5f-4d4f-bdb2-482761f813b6\",\n \"name\": \"Part Delivery\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.610Z\"\n },\n {\n \"id\": \"a0bb0bf2-5bf4-4635-95f0-3a88a7808e88\",\n \"name\": \"Part Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.625Z\"\n },\n {\n \"id\": \"df33d31c-c0ec-4718-95ab-d6515cfd9cdc\",\n \"name\": \"Valet Pickup\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"9220bfc1-fb28-4004-9e9f-09a598252a7a\",\n \"name\": \"Valet Drop-off\"\n },\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.645Z\"\n },\n {\n \"id\": \"9220bfc1-fb28-4004-9e9f-09a598252a7a\",\n \"name\": \"Valet Drop-off\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"df33d31c-c0ec-4718-95ab-d6515cfd9cdc\",\n \"name\": \"Valet Pickup\"\n },\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.666Z\"\n },\n {\n \"id\": \"61148baf-ec7b-4b72-8f75-00281f1d2912\",\n \"name\": \"Task\",\n \"kioskEnabled\": false,\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"487a1223-7300-4001-ba1f-086f5a0b12a6\",\n \"name\": \"Bravo Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.690Z\"\n }\n ]\n }\n]"}],"_postman_id":"1163a158-c03b-4f03-a9c3-ee11fd5cde1e"}],"id":"cfb7a03e-cec8-4af4-a592-f6d584150f83","description":"

This collection of API endpoints manages the lifecycle of workflows in ShuttleControl. Workflows are defined as the sequences of steps that compose a specific type of trip, whether it's for customer pickup and drop-off, or for parts logistics. Utilize these endpoints to create, retrieve, update, and delete workflows, ensuring your operations run smoothly and efficiently.

\n","_postman_id":"cfb7a03e-cec8-4af4-a592-f6d584150f83","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Vehicles","item":[{"name":"Create Vehicle","id":"4d398a66-1e42-4ac3-a9c4-1dfaf157146a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"CAR\",\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"licensePlate\": \"ABC 123\",\n \"seats\": 4,\n \"color\": \"black\",\n \"storeId\": \"{{storeId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicles","description":"

Adds a new vehicle to the fleet. This endpoint accepts vehicle details such as make, model, etc.

Retrieves a paginated list of vehicles in the fleet.

Fetches details for a single vehicle. This is typically used to view specific details or the current status of a vehicle.

Updates the details of an existing vehicle. This can include changes to any aspect of the vehicle's information that is stored in the system.

Deactivates a vehicle in the fleet so that it can't be used.

Similar to List Vehicles, but this endpoint retrieves every vehicle in the fleet.

This folder contains endpoints for managing vehicle resources within the fleet management application. The endpoints allow for creating, retrieving, updating, or deleting vehicles, as well as listing the entire fleet or a subset of vehicles as required.

\n","_postman_id":"9e00ffbf-45f3-4874-825b-6b87aa2b69a0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"MessageTemplates","item":[{"name":"Create MessageTemplate","id":"15365003-37d4-4ee7-affc-00f17ead03c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"SMS\",\n \"name\": \"Driver confirmed message\",\n \"storeId\": \"{{storeId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/messageTemplates","description":"

Craft and save new message templates that can be used across various workflow steps.

Retrieve a comprehensive list of all available message templates within the system.

Pagination index

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Maximum number of items per page

\n","type":"text/plain"},"key":"size","value":"5"},{"description":{"content":"

The account store ID

\n","type":"text/plain"},"key":"storeId","value":"{{storeId}}"}],"variable":[]}},"response":[{"id":"9a6b7051-b01d-4b2b-bb0d-37581048475b","name":"List MessageTemplates response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/messageTemplates?page=0&size=5&storeId={{storeId}}","host":["{{hostname}}"],"path":["v2","messageTemplates"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"storeId","value":"{{storeId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"459"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"eabc3a35-b9d0-4854-b2e9-7e72269c2dff\",\n \"type\": \"SMS\",\n \"name\": \"Driver confirmed message\",\n \"enabled\": true,\n \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-04-05T16:56:14.692Z\"\n },\n {\n \"id\": \"9b9d2dab-688d-42b3-a660-c52a07fa3fe2\",\n \"type\": \"SMS\",\n \"name\": \"Send Tracking Link\",\n \"enabled\": true,\n \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-04-05T14:18:12.041Z\"\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"ccf6f18a-8f14-4901-b405-8b72b10d79d0"},{"name":"Get MessageTemplate","id":"78d18547-d7be-4731-9c99-b83b85966b37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/messageTemplates/{{messageTemplateId}}","description":"

Access the details of a specific message template using its unique identifier.

Modify an existing message template to update its content or to align it with changes in the workflow process.

Remove a message template from the system when it is no longer needed or relevant.

The MessageTemplates resource in the ShuttleControl API serves as a centralized hub for managing the text templates of messages that are automatically sent to users during distinct steps of a workflow. This resource streamlines the communication process, ensuring consistency and efficiency in user interactions. Utilizing this resource, developers can perform the following actions:

POST Create MessageTemplate: Craft and save new message templates that can be used across various workflow steps.
GET List MessageTemplates: Retrieve a comprehensive list of all available message templates within the system.
GET Get MessageTemplate: Access the details of a specific message template using its unique identifier.
PUT Update MessageTemplate: Modify an existing message template to update its content or to align it with changes in the workflow process.
DEL Delete MessageTemplate: Remove a message template from the system when it is no longer needed or relevant.

\n","_postman_id":"9c2ef56b-09e6-4d78-ac2d-91e5579e57cb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Customers","item":[{"name":"Create Customer","id":"dbcdb223-2268-4466-846b-30c74b9c1c4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Noel\",\n \"lastName\": \"Sky\",\n \"language\": \"en\",\n \"address\": \"3901 Bannantyne, Verdun, QC H4G 1C2\",\n \"phoneNumber\": \"555 123 1234\",\n \"storeId\": \"{{storeId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customers","description":"

Creates a new customer record in the system.

Retrieves a list of all customers in the system, with query parameters for pagination.

Page index (zero-based)

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Page size

\n","type":"text/plain"},"key":"size","value":"5"}],"variable":[]}},"response":[{"id":"4d24f569-7198-4237-914e-a604c866ab1a","name":"List Customers response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/customers?page=0&size=5","host":["{{hostname}}"],"path":["v2","customers"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"854"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"dc697ec3-18ef-4479-8670-154b0a4a776a\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"companyName\": \"\",\n \"email\": \"\",\n \"language\": \"en\",\n \"phoneNumber\": \"555 543 6543\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-14T18:47:36.344Z\"\n },\n {\n \"id\": \"e332506d-a290-4ddc-acca-0200d3eae63d\",\n \"firstName\": \"Charlie\",\n \"lastName\": \"Adams\",\n \"companyName\": \"ACME Inc.\",\n \"email\": \"\",\n \"language\": \"en\",\n \"phoneNumber\": \"555 123 3456\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.903Z\"\n },\n {\n \"id\": \"37a3df2b-df7a-4c11-8046-49d041900300\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"companyName\": \"\",\n \"email\": \"\",\n \"language\": \"en\",\n \"phoneNumber\": \"514 699 7622\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.892Z\"\n }\n ],\n \"count\": 3\n}"}],"_postman_id":"28d80a11-60f9-4003-92f0-1418e1b69215"},{"name":"Get Customer","id":"0e236030-ebee-4fe0-ad99-81ca48662a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customers/{{customerId}}","description":"

Retrieves the details of a specific customer by their unique identifier.

Updates the details of an existing customer.

Deletes a specific customer from the system.

Allows searching for customers based on specific criteria.

Optional customer phone number

\n","type":"text/plain"},"key":"phoneNumber","value":"555"},{"description":{"content":"

Optional customer company name

\n","type":"text/plain"},"key":"companyName","value":null},{"description":{"content":"

Optional customer first name

\n","type":"text/plain"},"key":"firstName","value":null},{"description":{"content":"

Optional customer last name

\n","type":"text/plain"},"key":"lastName","value":null}],"variable":[]}},"response":[{"id":"8c6d7181-25f7-4fe6-a7dc-9efd50560578","name":"Search Customers response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/customers/search?phoneNumber=555&companyName&firstName&lastName","host":["{{hostname}}"],"path":["v2","customers","search"],"query":[{"key":"phoneNumber","value":"555","description":"Optional customer phone number"},{"key":"companyName","value":null,"description":"Optional customer company name"},{"key":"firstName","value":null,"description":"Optional customer first name"},{"key":"lastName","value":null,"description":"Optional customer last name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"202"},{"key":"ETag","value":"W/\"ca-2BlwQuo7mGYxK8WKtzVIpUPaw9U\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Tue, 12 Mar 2024 16:33:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"66d6c31b-c499-413f-8ad4-cb227ff9f631\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Johnson\",\n \"companyName\": \"\",\n \"email\": \"alex.johnson@example.com\",\n \"language\": \"en\",\n \"phoneNumber\": \"555 123 4567\",\n \"smsEnabled\": true\n }\n]"}],"_postman_id":"6a638f1d-3492-437d-be88-d5a19d83e52d"},{"name":"Create Customer Place","id":"570b0423-274f-4ee1-9a3b-a629e5a13dc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerId\": \"66d6c31b-c499-413f-8ad4-cb227ff9f631\",\n \"address\": \"1234 Rue Du Fort, Montréal, Quebec H3H 2B3, Canada\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customers/places","description":"

Associates a new place with a customer.

Removes an associated place from a customer's record.

The Customers API endpoints are designed for managing customer information and their associated places. These endpoints allow the creation, retrieval, update, and deletion of customer records as well as management of associated customer places.

\n","_postman_id":"c1ed0d80-3120-4c5a-9942-fd952c3fa9ed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"CustomerReviews","item":[{"name":"List CustomerReviews","id":"886f6135-38cb-4bac-a88a-25593c156365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews?page=0&size=5","description":"

Retrieves a paginated list of all customer reviews from the database. Use this endpoint to get an overview of customer feedback on drivers. Each review includes a unique identifier, the customer's rating, and their comments.

Page index (zero-based)

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Page size

\n","type":"text/plain"},"key":"size","value":"5"}],"variable":[]}},"response":[{"id":"c6474edb-15c7-4e28-b338-aac1e242e8e3","name":"List CustomerReviews response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/customerReviews?page=0&size=5","host":["{{hostname}}"],"path":["v2","customerReviews"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"622"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"customer\": {\n \"id\": \"dc697ec3-18ef-4479-8670-154b0a4a776a\",\n \"firstName\": \"Jamie\",\n \"lastName\": \"Tremblay\",\n \"email\": \"\"\n },\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"workflow\": {\n \"id\": \"117c7103-275e-4a18-ba2a-0556331fc408\",\n \"name\": \"Shuttle Pickup\"\n },\n \"customerReview\": {\n \"id\": \"a60f3fa6-70b2-4ca6-b349-169ef73dc38a\",\n \"rating\": 4.5,\n \"comment\": \"Thank you for such a wonderful shuttle experience!\",\n \"createdAt\": \"2023-03-16T15:02:21.435Z\"\n },\n \"drivers\": [],\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\",\n \"email\": \"edward+owner@shuttlecontrol.com\"\n }\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"886f6135-38cb-4bac-a88a-25593c156365"},{"name":"Create CustomerReview","id":"d2ddf6b6-7a87-4d8a-9be1-12674639f2b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tripId\": \"{{tripId}}\",\n \"rating\": 4.5,\n \"comment\": \"Thank you for such a wonderful shuttle experience!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customerReviews","description":"

Allows the submission of a new customer review. This endpoint is used to capture customer feedback post-trip.

\n","urlObject":{"path":["v2","customerReviews"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"3167c072-bb02-4c7d-a081-63f02328dc27","name":"Create CustomerReview response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tripId\": \"{{tripId}}\",\n \"rating\": 4.5,\n \"comment\": \"Thank you for such a wonderful shuttle experience!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customerReviews"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Location","value":"https://stage.api.shuttlecontrol.com/v2/customerReviews/b4fe0812-c81e-42b7-a07e-d2a9a22df085"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"206"},{"key":"ETag","value":"W/\"ce-2UONqR0oR3XGCkHkYnHkJdg73+I\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 15 Mar 2024 13:25:42 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b4fe0812-c81e-42b7-a07e-d2a9a22df085\",\n \"trip\": \"5b223143-15a1-47d5-aacf-8164ddb030eb\",\n \"rating\": 4.5,\n \"comment\": \"Thank you for such a wonderful shuttle experience!\",\n \"createdAt\": \"2024-03-15T13:25:42.597Z\"\n}"}],"_postman_id":"d2ddf6b6-7a87-4d8a-9be1-12674639f2b9"},{"name":"Get Customer Review","id":"082937e3-46b9-4d0e-ab27-07268111e84c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews/{{customerReviewId}}","description":"

Fetches a specific customer review by its unique identifier. This endpoint is useful for retrieving detailed information about individual feedback instances.

Returns the average rating and total number of reviews for a specific driver. This aggregate information helps gauge overall driver performance from the customer's perspective.

Removes a customer review from the database based on its unique identifier. This endpoint may be used for data management purposes or in response to a customer's request to delete their feedback.

The CustomerReviews resource in the ShuttleControl API contains a suite of endpoints for managing customer reviews on ShuttleControl.com. Users can list all reviews, create new reviews, retrieve specific reviews, obtain average ratings, and delete reviews as needed. These endpoints are essential for understanding customer experiences and improving the quality of service provided by drivers.

\n","_postman_id":"89dfb1a2-9f12-436d-a18a-e55dfb7bf349","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Places","item":[{"name":"Create Place","id":"00f83dcd-1993-42b2-9723-15c40eb50c2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"storeId\": \"{{storeId}}\",\n \"address\": \"3901 Rue Bannantyne, Verdun, QC H4G 1C2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/places","description":"

Creates a new place and marks it as a favorite. The request body should include all necessary details about the place such as address and relevant metadata.

Retrieves a paginated list of places, with an optional search parameter to filter the results. This endpoint can be used to fetch a subset of places for display or further processing. Pagination parameters can be adjusted as needed.

Page index (zero-based)

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Page size

\n","type":"text/plain"},"key":"size","value":"5"},{"key":"storeId","value":"{{storeId}}"}],"variable":[]}},"response":[{"id":"e45d26e1-93a4-4120-b84b-b1f82fdeefdf","name":"List Places response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/places?page=0&size=5&storeId={{storeId}}","host":["{{hostname}}"],"path":["v2","places"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"storeId","value":"{{storeId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"401"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"b6f8a2de-1fbf-4276-a4c3-269fdd25735d\",\n \"address\": \"3901 Rue Bannantyne, Verdun, QC H4G 1C2\",\n \"latitude\": 45.4651011,\n \"longitude\": -73.5759264,\n \"isFavorite\": true,\n \"createdAt\": \"2023-04-06T17:07:28.032Z\"\n },\n {\n \"id\": \"8cbe98a0-0838-4994-a9ff-38970798f8d9\",\n \"address\": \"Saint Joseph's Oratory of Mount Royal\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"isFavorite\": true,\n \"createdAt\": \"2023-04-05T14:18:11.960Z\"\n }\n]"}],"_postman_id":"4f602b80-6a8c-4645-856d-e1d1abd040dc"},{"name":"Favorite Place","id":"2c4037a9-8d15-4bf0-9445-80bbd4fd51ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{hostname}}/v2/places/favorite/{{placeId}}","description":"

Marks an existing place as a favorite. Favorited places are given preferential visibility in address search results.

Unfavorites a place.

Fetches all favorited places from the database. This can be used for retrieving all favorite places without pagination.

Retrieves the details of a single place, identified by a unique place identifier. This endpoint can be used to fetch detailed information about a specific place.

This folder contains all the API endpoints for managing 'Places' in our fleet management system. 'Places' are pickup and drop-off addresses. Users can create new places, list existing places, mark places as 'favorites', and more. Favorites are addresses that are used frequently and are thus given priority in search completion results.

\n","_postman_id":"7fd3492b-b62a-4cb5-8ada-0ea117062729","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Zones","item":[{"name":"Create Zone","id":"1e9e1295-7dd3-40f4-b99b-d0e68c1bc62e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"geometry\": \"_fvtGdyh`MxrBq|Hm~C?cr@p|Hv}A?\",\n \"name\": \"Alpha Zone\",\n \"color\": \"blue\",\n \"storeId\": \"{{storeId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/zones","description":"

This endpoint allows for the creation of a new zone. It requires the definition of zone boundaries and any relevant metadata associated with the zone, such as name, and color.

Retrieve a paginated list of zones created for a particular store. This endpoint can be used to display existing zones, review their boundaries, and manage them through other endpoints.

Page index

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Maximum page size

\n","type":"text/plain"},"key":"size","value":"5"},{"description":{"content":"

Optionals store Id, If not given, then zones for all stores are returns.

\n","type":"text/plain"},"key":"storeId","value":"{{storeId}}"}],"variable":[]}},"response":[{"id":"ce3a83fe-aa93-4675-8a37-6da8a35000b3","name":"List Zones response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/zones?page=0&size=5&storeId={{storeId}}","host":["{{hostname}}"],"path":["v2","zones"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"storeId","value":"{{storeId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"68d451ee-99af-4b72-93d1-74cd5f891de5\",\n \"name\": \"Alpha Zone\",\n \"color\": \"blue\",\n \"geometry\": \"_fvtGdyh`MxrBq|Hm~C?cr@p|Hv}A?\",\n \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\"\n },\n \"createdAt\": \"2023-04-11T13:08:40.175Z\",\n \"createdBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n },\n {\n \"id\": \"a6b45a7a-1402-42f5-a045-ca0a07ca5038\",\n \"name\": \"Alpha Zone\",\n \"color\": \"blue\",\n \"geometry\": \"gfytGx`d`Mf_BjwCxrBq|H??\",\n \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\"\n },\n \"createdAt\": \"2023-04-11T13:04:04.729Z\",\n \"createdBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n },\n {\n \"id\": \"83f89048-1c83-470c-875d-4f8ea886682e\",\n \"name\": \"Alpha Zone\",\n \"color\": \"blue\",\n \"geometry\": \"_~ntGvp_`Mtj@fCo@nr@_YlSmNqU\",\n \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\"\n },\n \"createdAt\": \"2023-04-11T13:03:13.326Z\",\n \"createdBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n }\n ],\n \"count\": 3\n}"}],"_postman_id":"519a3d1f-0026-43ca-87a3-6fc3d99e5fb5"},{"name":"Get Zone","id":"0b516f13-0d5c-41ee-9bf9-3f7cea831600","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/zones/{{zoneId}}","description":"

Fetch detailed information about a specific zone by its unique identifier. This is useful for editing, reviewing, or debugging information related to a zone.

Remove an existing zone from the system. This operation should be used with caution as it will permanently delete the zone and may affect operational logistics if used inappropriately.

Retrieve a list of zones grouped by store. This endpoint can be used to display zone selectors.

Optional store Id. If not given, zones for all stores are returned

\n","type":"text/plain"},"key":"storeId","value":"{{storeId}}"}],"variable":[]}},"response":[{"id":"8f394412-4db5-432a-b58e-806fcc07fc59","name":"Grouped Zones response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/zones/grouped?storeId={{storeId}}","host":["{{hostname}}"],"path":["v2","zones","grouped"],"query":[{"key":"storeId","value":"{{storeId}}","description":"Optional store Id. If not given, zones for all stores are returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"187"},{"key":"ETag","value":"W/\"bb-xbwstPEyY9T2M80W4dd+YtTK8wQ\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Wed, 28 Feb 2024 19:57:52 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"63fab983-9250-4883-9214-b420099d855d\",\n \"name\": \"Alpha Store\",\n \"zones\": [\n {\n \"id\": \"21ee2943-466f-41db-88d7-7ca9400c9cc4\",\n \"name\": \"Alpha Store Zone\",\n \"color\": \"springgreen\",\n \"enabled\": true\n }\n ]\n }\n]"}],"_postman_id":"fa6efdab-371a-40dc-96a6-3b4fde0d22cf"},{"name":"Update Zone","id":"c4095a4c-115e-4bf1-b76d-d7a36324006a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"geometry\": \"pmk`M{eytGguCdmArlChqB|pCg|AihCgbB\",\n \"name\": \"Alpha Store Zone\",\n \"color\": \"blue\",\n \"storeId\": \"{{storeId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/zones/{{zoneId}}","description":"

Update an existing zone.

Retrieve a list of all zones created for a particular store. This endpoint can be used to display existing zones, review their boundaries, and manage them through other endpoints.

The Zones resource encompasses a suite of API endpoints designed to facilitate the management of geographical zones within the ShuttleControl platform. This feature allows administrators and users of ShuttleControl to define, retrieve, and manage map zones for each store or location within an account. Each zone represents a specific area where pickup or delivery services are available, ensuring that customers can be serviced efficiently within designated operational perimeters.

POST Create Zone: This endpoint allows for the creation of a new zone. It requires the definition of zone boundaries and any relevant metadata associated with the zone, such as name, and color.
GET List Zones: Retrieve a paginated list of zones created for a particular store. This endpoint can be used to display existing zones, review their boundaries, and manage them through other endpoints.
GET Grouped Zones: Retrieve a list of zones grouped by store. This endpoint can be used to display zone selectors.
GET Get Zone: Fetch detailed information about a specific zone by its unique identifier. This is useful for editing, reviewing, or debugging information related to a zone.
DEL Delete Zone: Remove an existing zone from the system. This operation should be used with caution as it will permanently delete the zone and may affect operational logistics if used inappropriately.
PUT Update Zone: Update an existing zone.
GET List All Zones: Retrieve a list of all zones created for a particular store. This endpoint can be used to display existing zones, review their boundaries, and manage them through other endpoints.

Note: All operations within this collection are subject to authorization and permission checks as per ShuttleControl's security protocols. Ensure that your API calls include the necessary authentication headers to interact with these endpoints successfully.

\n","_postman_id":"71163bad-a54f-4679-a9b8-8d7209ced7a1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"OSRM","item":[{"name":"Route","id":"3deb982b-d2b3-4de1-bb62-2185398d26cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"points\": [\n {\n \"latitude\": 45.457755310612356,\n \"longitude\": -73.59553709374609\n },\n {\n \"latitude\": 45.45205785618882,\n \"longitude\": -73.59109305052687\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/osrm/route","description":"

Obtain a route polyline from an array of points.

The OSRM resource in the ShuttleControl API allows route polylines to be generated from arrays of points (i.e., latitude/longitude pairs) using the Open Source Routing Machine.

\n","_postman_id":"dd4c0866-89e4-43bf-82c6-604f3cd5ddfd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}},{"name":"Stores","item":[{"name":"Get Stores","id":"bbda6349-44f3-40fb-8bae-7024e887201b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{hostname}}/v2/stores","description":"

Retrieves a list of all active customer business locations currently registered on the ShuttleControl.com platform. It provides essential details for each store, enabling a comprehensive overview of active service points.

Fetches a list of all customer business locations that have been archived. Archived stores are locations that are temporarily inactive and not currently in service but can be restored when needed.

Creates a new store representing a customer business location on ShuttleControl.com. This endpoint requires details about the new location, such as its name, address, and operational specifics, to initialize services for the location.

Archives an active store, temporarily removing it from the active service list without deleting its information. This action is reversible; archived stores can be restored to active status when required.

Restores an archived store to the active service list. It re-enables the fleet management functions for the specified location on ShuttleControl.com, putting it back into service.

Retrieves detailed information about a specific store. It requires the store's unique identifier and provides detailed operational data and configuration settings for the location.

Updates the details of an existing store. This can include changes to the name, address, operational hours, or other relevant details.

The 'Stores' folder contains a set of endpoints for managing customer business locations within the ShuttleControl.com fleet management platform. Each 'store' represents a distinct business location that uses the platform for fleet management activities. The folder allows for the retrieval of store details, the creation and update of store information, as well as the management of store archival status.

\n","_postman_id":"616c29d6-b8fc-4247-9fc6-034be93ded72","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","id":"37ebbaf7-dba8-4eac-b34c-002c858aa03f","name":"ShuttleControl Open API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"20b22f60-6e4d-4706-be69-f545aa1a3985","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c328691-9f5c-4112-936f-2b85e92246b2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"messageType","value":"\"SMS\""}]}