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.
\nReplace {{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":"Accounts","item":[{"name":"Get Account","id":"c839b147-33bf-4a0c-acf8-0907284822bf","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/accounts/me","description":"Returns the account of the authenticated caller.
\n⚠️ The response includes the account’s apiKey — treat it like a password.
Returns the account object: id, apiKey, name, plan (BASIC | SHUTTLECONTROL | FLEET), industry, phoneNumber, timezoneId (IANA), uom (METRIC | IMPERIAL), country (ISO 3166-1 alpha-2), monthlyReportEnabled, stripeConnectAccountId, stripeConnectAccountOnboarded, createdAt, updatedAt.
Updates account-level settings. All fields are optional — only the fields present in the body are changed.
\nRequired role: OWNER or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated account object.
\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","accounts","me"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"c34933b1-b0c0-4dcf-8c77-e615386513a9","name":"Update Account response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"ACME Inc.\",\n \"uom\": \"METRIC\",\n \"country\": \"CA\",\n \"industry\": \"AUTOMOTIVE\",\n \"phoneNumber\": \"555 123 1234\",\n \"monthlyReportEnabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/accounts/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"215"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a9d32a39-86e0-4c8f-a69e-6aa2a56f2ac8\",\n \"name\": \"ACME Inc.\",\n \"uom\": \"METRIC\",\n \"country\": \"CA\",\n \"industry\": \"AUTOMOTIVE\",\n \"phoneNumber\": \"555 123 1234\",\n \"monthlyReportEnabled\": false,\n \"updatedAt\": \"2023-03-16T15:29:27.213Z\"\n}"}],"_postman_id":"f169ce24-2a10-422e-a246-0c2eff5411f7"},{"name":"Get Billing Portal","id":"6602484e-5799-42ad-a9d1-f23f9133d296","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/accounts/billingPortal","description":"Creates a Stripe billing-portal session for the account and returns its URL. Direct the user’s browser to this URL to let them manage payment methods, invoices, and their subscription.
\nRequired role: BILLING or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { url } — a short-lived Stripe billing portal link. Responds 400 if the account has no Stripe customer.
Manage the account that owns your stores, users, and subscription.
\n","_postman_id":"6f74ba4e-8ca0-44fa-9ea5-10d720bd0807","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":"df0ba39d-fc17-48b0-8033-c384461024b8","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"driver@example.com\",\n \"role\": \"DRIVER\",\n \"language\": \"en\",\n \"firstName\": \"Sam\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+1 514 555 0111\",\n \"storeIds\": [\n \"9f2d1c34-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/users","description":"Creates a new user and emails them an invitation to set their password. The email address must not already be in use (responds 409 if it is — see Retake User to re-enable a previously deactivated user).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created user and a Location header. password and loginToken are never returned.
Re-enables a previously deactivated user on your account, overwriting their role, name, language, phone number, and store assignments, and re-sends the invitation email. Responds 404 if no user exists with that email, and 400 if the user is currently active.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the re-enabled user.
Returns a paginated list of active users visible to the caller, optionally filtered by store, role, or a free-text search.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count, total, userLimit } — count is the number of matches, total the account-wide user count, and userLimit your plan’s cap.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Repeatable UUID filter: only users assigned to these stores.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"Free-text search (max 100 characters) over user names/emails.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by role: ADMIN | DISPATCHER | DRIVER | OWNER | BILLING.
Returns a paginated list of deactivated users, with the same filters as List Users.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count }.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Repeatable UUID filter: only users assigned to these stores.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"Free-text search (max 100 characters).
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by role.
\n","type":"text/plain"},"key":"role","value":""}],"variable":[]}},"response":[],"_postman_id":"fc709163-cda7-4f33-9fae-7f3a40e98824"},{"name":"List All Users","id":"7797f646-10a4-44dc-9225-51eb66d57b6c","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/users?roles=DRIVER","description":"Returns a lightweight, non-paginated list of active users matching the given roles — useful for populating pickers (e.g. all drivers of a store).
\nReturns an array of { id, firstName, lastName, role }.
Required, repeatable. One or more of ADMIN, DISPATCHER, DRIVER, OWNER, BILLING.
Repeatable UUID filter. Default: every store visible to the caller.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"union (member of any listed store, default) or intersection (member of every listed store).
Returns a single user. The user must belong to a store visible to the caller.
\nReturns the user object (id, role, email, names, language, phoneNumber, stores, timestamps, …).
\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",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"e44ad3b0-a7f3-4b52-bbf4-f5202394e202","description":{"content":"UUID of the user to fetch.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"04f3542b-f119-4cd6-953a-7a3642312eb2","name":"Get User response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/users/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\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}"}],"_postman_id":"28f0982d-57ff-4945-81ee-9c7670b41da0"},{"name":"Update User","id":"d86757df-28fb-4e76-9dd0-f2fc22365333","request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Sam\",\n \"lastName\": \"Lee\",\n \"role\": \"DISPATCHER\",\n \"storeIds\": [\n \"9f2d1c34-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/users/:id","description":"Partially updates a user on your account. All fields are optional — only the fields present are changed. Changing the email resets its verified status.
\nGuards: a DRIVER with confirmed trips cannot change role or be removed from a store (400 USER_HAS_CONFIRMED_TRIPS).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated user object.
\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",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"748a2268-f2ee-4ead-ab16-b8405da22e0d","description":{"content":"UUID of the user to update.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d86757df-28fb-4e76-9dd0-f2fc22365333"},{"name":"Update My Profile","id":"642bd4a6-2d2d-429c-8ad0-7d395bab6c39","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1 514 555 0100\",\n \"language\": \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/users/me","description":"Updates the authenticated user’s own profile. All fields are required (send the current value for anything you don’t want to change).
\nResponds 204 No Content.
Changes a password. Without id, changes the authenticated user’s own password. With id, an OWNER or ADMIN changes another user’s password (the target must be visible to the caller). A confirmation email is sent to the affected user.
Responds 204 No Content.
Transfers account ownership to another user. The target becomes OWNER (and is assigned to every store on the account); the caller is demoted to ADMIN. The Stripe customer contact is updated to the new owner.
Required role: OWNER or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
Soft-deletes (deactivates) a user. Drivers with confirmed trips cannot be deactivated (400 USER_HAS_CONFIRMED_TRIPS); a driver’s claimed vehicle is automatically released. Deactivated users can be restored with Reactivate User or Retake User.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the deactivated user object.
\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",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"c926657a-a2cd-41c7-bdfa-b2a1499c65e9","description":{"content":"UUID of the user to deactivate.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bcca6e10-a6e8-4b25-88cb-327496b65d3e","name":"Deactivate User response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/users/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"151"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"515e4f0e-fc7a-4484-a1f9-cc7ed568eb76\",\n \"enabled\": false,\n \"updatedAt\": \"2023-03-16T19:17:04.345Z\",\n \"updatedBy\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\"\n}"}],"_postman_id":"a0ed9ca3-4bd5-4e61-8fb2-bea7c23958a3"},{"name":"Reactivate User","id":"f5581524-d8b3-49b9-a09a-b0a8d2bf91f5","request":{"method":"POST","header":[],"url":"{{hostname}}/v2/users/:id/reactivate","description":"Re-enables a deactivated user without changing any of their details. Responds 400 if the user is already active.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the reactivated user object.
\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",":id","reactivate"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"227c2166-e364-498e-a4d9-1620cdc9de3d","description":{"content":"UUID of the user to reactivate.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2350b7fd-74ca-46cd-99aa-e739dc5be022","name":"Reactivate User response","originalRequest":{"method":"POST","header":[],"url":"{{hostname}}/v2/users//reactivate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"150"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"515e4f0e-fc7a-4484-a1f9-cc7ed568eb76\",\n \"enabled\": true,\n \"updatedAt\": \"2023-03-16T19:18:09.219Z\",\n \"updatedBy\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\"\n}"}],"_postman_id":"f5581524-d8b3-49b9-a09a-b0a8d2bf91f5"},{"name":"Assign Stores","id":"3c8bb523-1518-433d-bbda-c381c2467aba","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"4be9f1e0-0000-0000-0000-000000000000\"\n ],\n \"stores\": [\n \"9f2d1c34-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/users/assignStores","description":"Bulk-assigns stores to users. Each listed user is added to each listed store (existing assignments are kept — this endpoint never removes assignments). All users and stores are validated against the caller’s account before any change is applied.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
Sets the authenticated user’s UI theme preference (used by the ShuttleControl apps).
\nResponds 204 No Content.
Registers a Firebase Cloud Messaging token for the authenticated user so they receive mobile push notifications. Used by the ShuttleControl Driver app; each user holds a single token (a new registration replaces the previous one).
\nResponds 204 No Content.
Clears the authenticated user’s push-notification token (e.g. on sign-out of the mobile app).
\nResponds 204 No Content.
Uploads (or replaces) the authenticated user’s profile image.
\nReturns { profileUrl } — the stored image path.
Deletes the authenticated user’s profile image.
\nResponds 204 No Content. 404 if no image is set.
Uploads (or replaces) another user’s profile image. The target user must be visible to the caller.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { profileUrl }.
UUID of the user.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"0b2d8449-9764-4998-8eb5-ac33a7e3e89a"},{"name":"Get User Profile Image","id":"baf5b1dc-e84c-4100-9984-e19dda6c342a","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/users/:id/image","description":"Returns the raw profile image binary for a user. This endpoint is unauthenticated so it can be used directly in <img> tags.
Returns the image with its original Content-Type (image/png or image/jpeg). 404 if the user has no image.
UUID of the user.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"baf5b1dc-e84c-4100-9984-e19dda6c342a"},{"name":"Remove User Profile Image","id":"1aa48416-6cb1-47ff-ad0a-fbce55e3c93a","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/users/:id/image","description":"Deletes another user’s profile image. The target user must be visible to the caller.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the user.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1aa48416-6cb1-47ff-ad0a-fbce55e3c93a"}],"id":"d18d3b80-c42f-47ad-adce-322b3dda4ecd","description":"Manage the staff on your account. User roles: ADMIN | DISPATCHER | DRIVER | OWNER | BILLING. Endpoints under /me act on the authenticated caller — when authenticating with an API key, “me” is the account owner.
Creates a trip for a store and workflow, optionally creating the customer inline and/or a linked return trip.
\ncustomerId is omitted or null, a customer is created from firstName/lastName/companyName/email/phoneNumber/language.scheduledAt is required when state is SCHEDULED.400 TRIP_IS_OUTSIDE_STORE_RADIUS.Each step object: name (string, required), type (string, required — message | place | image | images | task | signature | video), position (integer ≥ 1, required — execution order), messageTemplate ({ id: UUID }, optional — for message steps), place ({ address: string, latitude?: number, longitude?: number }, optional — for place steps; coordinates are geocoded from the address when omitted).
Responds 201 with the created trip and a Location header.
Returns a single trip with its customer, workflow, steps, drivers, vehicle, and state timestamps. The trip’s store must be visible to the caller.
\nReturns the full trip object.
\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","trips",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"7c8c1cd9-fb82-41ce-9631-42a84c8de9b8","description":{"content":"UUID of the trip.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8005aca0-ada6-4a16-9bfd-324e90347a2d","name":"Get Trip response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/"},"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":"ad566a80-b289-4a15-b3b9-61b558f689ec"},{"name":"List Trips History","id":"4973aba8-2f41-424d-a540-6a424345d9d6","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/history?startDate=2026-07-01T00:00:00.000Z&endDate=2026-07-31T23:59:59.000Z&page=0&size=10","description":"Returns a paginated list of finished (COMPLETED / CANCELLED) trips whose finishedAt falls between startDate and endDate, with rich filtering.
Returns { items, count }.
Required. ISO 8601 date; must be in the past. Window start (inclusive), matched against finishedAt.
Required. ISO 8601 date. Window end (inclusive).
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"description":{"content":"Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Filter to one store (must be visible to the caller).
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter by the user who created the trip.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Filter by an assigned driver UUID, or the literal UNASSIGNED for trips with no driver.
mostRecent (default) | leastRecent (by scheduled/requested time) | mostRecentEndDate | leastRecentEndDate (by finish time).
COMPLETED or CANCELLED. Default: both.
SCHEDULED (has a scheduled time) or REQUESTED (asap).
Free-text search (max 100) over reference, customer name/company/phone, and trip notes.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"Filter by zone.
\n","type":"text/plain"},"key":"zoneId","value":""},{"disabled":true,"description":{"content":"true (default) for normal trips, false for archived trips.
Returns finished trips’ step coordinates for the given window, intended for rendering pickup/dropoff heatmaps. Accepts the same filters as List Trips History (minus pagination and sort).
\nReturns an array of trips, each with scheduledAt, requestedAt, and steps[].place (latitude, longitude, address).
Required. ISO 8601; must be in the past.
\n","type":"text/plain"},"key":"startDate","value":"2026-07-01T00:00:00.000Z"},{"description":{"content":"Required. ISO 8601.
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"disabled":true,"description":{"content":"Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter by creating dispatcher.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Driver UUID or UNASSIGNED.
COMPLETED or CANCELLED. Default: both.
Free-text search (max 100).
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"Filter by zone.
\n","type":"text/plain"},"key":"zoneId","value":""}],"variable":[]}},"response":[],"_postman_id":"59ffb3f3-b4fe-4a5d-8e39-3bb2d79588a1"},{"name":"Store Trip Analytics","id":"6b805ae7-afb0-4543-b53a-70e40f4df916","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/analytics/store?startDate=2026-07-01T00:00:00.000Z&endDate=2026-07-31T23:59:59.000Z&granularity=day&timezoneOffset=-240","description":"Returns per-store trip-volume time series (bucketed by the chosen granularity) plus an aggregate, for the given window.
\nReturns { stores: [{ name, color, data }], aggregate }.
Required. ISO 8601 window start (matched on trip creation time).
\n","type":"text/plain"},"key":"startDate","value":"2026-07-01T00:00:00.000Z"},{"description":{"content":"Required. ISO 8601 window end.
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"description":{"content":"Required. Bucket size: day | week | month.
Required. Caller’s UTC offset in minutes, used to align buckets to local days.
\n","type":"text/plain"},"key":"timezoneOffset","value":"-240"},{"disabled":true,"description":{"content":"Filter to one store. Default: all visible stores.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter by creating dispatcher.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Repeatable driver UUID filter.
\n","type":"text/plain"},"key":"driverIds","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"COMPLETED or CANCELLED.
Returns per-driver trip-volume time series plus an aggregate, for the given window. Same parameters as Store Trip Analytics; when driverIds is omitted, every driver of the visible stores is included.
Returns { drivers: [{ name, data }], aggregate }.
Required. ISO 8601 window start.
\n","type":"text/plain"},"key":"startDate","value":"2026-07-01T00:00:00.000Z"},{"description":{"content":"Required. ISO 8601 window end.
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"description":{"content":"Required. day | week | month.
Required. Caller’s UTC offset in minutes.
\n","type":"text/plain"},"key":"timezoneOffset","value":"-240"},{"disabled":true,"description":{"content":"Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter by creating dispatcher.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Repeatable driver UUID filter. Default: all drivers.
\n","type":"text/plain"},"key":"driverIds","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"COMPLETED or CANCELLED.
Moves a trip into the PENDING state (parked for later dispatch), unassigning it from active dispatch.
Responds 204 No Content.
UUID of the trip.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"77218e63-38a0-40af-a01e-27729766ede4"},{"name":"Create Trip Step Geostamp","id":"0ff8507a-6afd-47bb-9de1-e9be1f008bea","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coords\": {\n \"latitude\": 45.5019,\n \"longitude\": -73.5674,\n \"altitude\": 35,\n \"accuracy\": 5,\n \"altitude_accuracy\": 8,\n \"heading\": 90,\n \"speed\": 11.2\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/trips/:id/steps/:stepId/geostamp","description":"Records the trip vehicle’s GPS fix against a trip step (a “geostamp” proving where the step happened). The trip must have a vehicle assigned (400 otherwise).
Responds 204 No Content.
UUID of the trip.
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"id":"3e062adf-ed72-45d7-b1fb-69f93faf47ad","description":{"content":"UUID of the trip step to stamp.
\n","type":"text/plain"},"type":"any","value":"","key":"stepId"}]}},"response":[],"_postman_id":"0ff8507a-6afd-47bb-9de1-e9be1f008bea"},{"name":"Download Trip PDF","id":"596be0fe-bff5-437f-99cb-b4542a0997c9","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/trips/:id/pdf","description":"Generates and returns a PDF summary of the trip (customer, steps, timestamps, signatures).
\nReturns the PDF binary with Content-Type: application/pdf.
UUID of the trip.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"596be0fe-bff5-437f-99cb-b4542a0997c9"}],"id":"725c983c-9187-4873-bafb-685d679d1f0d","description":"Create and inspect trips. Trip states: REQUESTED (asap), SCHEDULED (for a specific time), PENDING (parked for later dispatch), CONFIRMED (accepted by a driver), COMPLETED, CANCELLED.
Creates a workflow. The shape of the body depends on workflowType:
When emailRequired / phoneNumberRequired are omitted, defaults depend on the account country: North American accounts default to phone-number-required, others to email-required.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created workflow (including its generated steps for template types).
Returns a paginated list of active workflows for the caller’s stores, including their notification template assignments.
\nReturns { items, count }.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Filter to one store (must be visible to the caller).
\n","type":"text/plain"},"key":"storeId","value":""}],"variable":[]}},"response":[{"id":"f95dabb4-e324-44ef-af8b-01479084d49e","name":"List Workflows response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/workflows/list?page=0&size=5","host":["{{hostname}}"],"path":["v2","workflows","list"],"query":[{"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\": \"c1885ec0-f5cf-4922-a294-741911257065\",\n \"name\": \"Shuttle Drop-off\",\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"a8e2c634-0ab4-46f6-85dc-ada9cda81331\",\n \"name\": \"Shuttle Pickup\"\n },\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.920Z\"\n },\n {\n \"id\": \"a8e2c634-0ab4-46f6-85dc-ada9cda81331\",\n \"name\": \"Shuttle Pickup\",\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"c1885ec0-f5cf-4922-a294-741911257065\",\n \"name\": \"Shuttle Drop-off\"\n },\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.936Z\"\n },\n {\n \"id\": \"28d88bad-9128-42ba-a5c7-a94ba35b20c2\",\n \"name\": \"Part Delivery\",\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.951Z\"\n },\n {\n \"id\": \"3f3f90af-705e-4673-96c8-b93b6b271085\",\n \"name\": \"Part Pickup\",\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": null,\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.959Z\"\n },\n {\n \"id\": \"ae2e1537-b365-415e-b5f7-13f7f9327c55\",\n \"name\": \"Valet Pickup\",\n \"description\": \"\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"ab24e1a9-e8bc-4796-a511-a03dc4afecda\",\n \"name\": \"Valet Drop-off\"\n },\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.966Z\"\n }\n ],\n \"count\": 16\n}"}],"_postman_id":"a21394af-eb20-4a17-a023-886ad3c5eb19"},{"name":"List All Workflows","id":"28491bed-6e2a-4d16-8e3a-e8a291b0a6e9","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/workflows","description":"Returns all active workflows that have at least one step, grouped by store — the set a trip can actually be created against.
\nReturns an array of stores, each with id, name, and workflows (id, name, description, color, allowActivateByDriver, defaultReturnTripWorkflow).
Repeatable UUID filter. Default: all stores visible to the caller.
\n","type":"text/plain"},"key":"storeIds","value":""}],"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":"28491bed-6e2a-4d16-8e3a-e8a291b0a6e9"},{"name":"Get Workflow","id":"5e487c1e-84bb-4abc-ad6c-32e53dde4c16","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/workflows/:id","description":"Returns a single workflow with its steps and settings.
\nReturns the workflow object, plus isUsedAsReturnTripWorkflow (boolean) indicating whether another workflow uses it as its default return-trip workflow.
UUID of the workflow.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3cc77cce-f561-4e70-b73b-826407f2c887","name":"Get Workflow response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/workflows/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a8e2c634-0ab4-46f6-85dc-ada9cda81331\",\n \"name\": \"Shuttle Pickup\",\n \"description\": \"\",\n \"enabled\": true,\n \"customerReviewsEnabled\": false,\n \"customerRequired\": true,\n \"emailRequired\": false,\n \"companyNameRequired\": false,\n \"phoneNumberRequired\": true,\n \"enableScheduledTripSms\": true,\n \"tripOptimizationHeuristic\": \"MINIMIZE_DURATION\",\n \"defaultReturnTripWorkflow\": {\n \"id\": \"c1885ec0-f5cf-4922-a294-741911257065\"\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 }\n },\n \"steps\": [\n {\n \"id\": \"ba58ad87-a5b7-49ab-bf22-fd0ebe87c1b8\",\n \"type\": \"message\",\n \"name\": \"Send tracking link\",\n \"place\": null,\n \"position\": 1,\n \"messageTemplate\": {\n \"id\": \"c8bbb1cd-7c53-42fa-9f8f-595b313b94ee\",\n \"name\": \"Send Tracking Link\",\n \"type\": \"SMS\",\n \"locales\": [\n {\n \"language\": \"en\",\n \"template\": \"Hi {{{customerName}}}, your driver is on the way! Track your driver: {{{trackingLink}}}\"\n },\n {\n \"language\": \"fr\",\n \"template\": \"Bonjour {{{customerName}}}, votre chauffeur est on route! {{{trackingLink}}}\"\n }\n ]\n },\n \"createdAt\": \"2023-03-13T18:05:39.941Z\",\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n },\n {\n \"id\": \"ca88a4d3-9813-469e-916a-fe61f6d669e0\",\n \"type\": \"place\",\n \"name\": \"Pickup customer\",\n \"place\": null,\n \"position\": 2,\n \"messageTemplate\": null,\n \"createdAt\": \"2023-03-13T18:05:39.944Z\",\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n },\n {\n \"id\": \"3b80e7bb-85fe-452e-bc9f-e1d7256a12be\",\n \"type\": \"place\",\n \"name\": \"Bring customer to 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 },\n \"position\": 3,\n \"messageTemplate\": null,\n \"createdAt\": \"2023-03-13T18:05:39.947Z\",\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n }\n ],\n \"createdAt\": \"2023-03-13T18:05:39.936Z\",\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n}"}],"_postman_id":"5e487c1e-84bb-4abc-ad6c-32e53dde4c16"},{"name":"Update Workflow","id":"2957e14d-303d-40f8-90ad-483936e87bd0","request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Airport pickup\",\n \"customerReviewsEnabled\": true,\n \"maximumScheduledAtDays\": 30\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/workflows/:id","description":"Partially updates a workflow’s settings. All fields are optional — only the fields present are changed.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated workflow object.
\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",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"4ea89310-4d71-4229-a166-8c65f648871b","description":{"content":"UUID of the workflow.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c2beeaab-5719-4b6b-9d19-30a13e60463d","name":"Update Workflow response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Shuttle Pickup\",\n \"description\": \"To bring the customer to the store.\",\n \"customerRequired\": true,\n \"emailRequired\": false,\n \"defaultReturnTripWorkflow\": null,\n \"enableScheduledTripSms\": true,\n \"customerReviewsEnabled\": true,\n \"phoneNumberRequired\": true,\n \"tripOptimizationHeuristic\": \"MINIMIZE_DURATION\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/workflows/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"425"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"tripOptimizationHeuristic\": \"MINIMIZE_DURATION\",\n \"description\": \"To bring the customer to the store.\",\n \"enableScheduledTripSms\": true,\n \"id\": \"117c7103-275e-4a18-ba2a-0556331fc408\",\n \"defaultReturnTripWorkflow\": null,\n \"customerRequired\": true,\n \"phoneNumberRequired\": true,\n \"customerReviewsEnabled\": true,\n \"name\": \"Shuttle Pickup\",\n \"updatedAt\": \"2023-03-14T19:18:37.174Z\",\n \"updatedBy\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"emailRequired\": false\n}"}],"_postman_id":"2957e14d-303d-40f8-90ad-483936e87bd0"},{"name":"Delete Workflow","id":"fc397241-77bc-4a5b-aadd-be73352f3152","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/workflows/:id","description":"Soft-deletes (disables) a workflow. Any other workflow using it as a default return-trip workflow is automatically disassociated.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the workflow.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1210492a-f704-4404-a5ac-85d23f318e68","name":"Delete Workflow response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/workflows/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fc397241-77bc-4a5b-aadd-be73352f3152"}],"id":"4571a5ab-132e-4cc7-9803-ba1998d7d4c2","description":"Workflows define the shape of a trip: its steps, required customer fields, scheduling rules, and the message templates used to notify customers at each state change.
\n","_postman_id":"4571a5ab-132e-4cc7-9803-ba1998d7d4c2","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":"024118bf-daba-43e2-84f6-e7205987643d","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"VAN\",\n \"make\": \"Ford\",\n \"model\": \"Transit\",\n \"licensePlate\": \"ABC 123\",\n \"seats\": 8,\n \"color\": \"White\",\n \"storeId\": \"9f2d1c34-0000-0000-0000-000000000000\",\n \"description\": \"Courtesy shuttle #1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicles","description":"Creates a vehicle in a store.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created vehicle and a Location header.
Returns a paginated list of active vehicles for the caller’s stores.
\nReturns { items, count, total, vehicleLimit } — total is the account-wide vehicle count and vehicleLimit your plan’s cap.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Repeatable UUID filter.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"Free-text search over make/model/plate.
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"639d60ad-cf6c-4fb5-a0c8-0ada4c69ae19","name":"List Vehicles response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/vehicles?page=0&size=5","host":["{{hostname}}"],"path":["v2","vehicles"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"948"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"584fe92f-8bd8-4424-b94a-437585badd13\",\n \"driver\": null,\n \"type\": \"CAR\",\n \"enabled\": true,\n \"seats\": 4,\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"color\": \"black\",\n \"licensePlate\": \"ABC 123\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"vehicleCoordinate\": null,\n \"createdAt\": \"2023-03-15T15:22:28.982Z\"\n },\n {\n \"id\": \"ba2961cc-978e-4ae3-a969-b35fc18caf0c\",\n \"driver\": null,\n \"type\": \"CAR\",\n \"enabled\": true,\n \"seats\": 4,\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"color\": \"black\",\n \"licensePlate\": \"ABC 123\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"vehicleCoordinate\": null,\n \"createdAt\": \"2023-03-15T15:20:08.356Z\"\n },\n {\n \"id\": \"3f932af4-8440-4fd1-a581-3a68d2160d04\",\n \"driver\": null,\n \"type\": \"CAR\",\n \"enabled\": true,\n \"seats\": 4,\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"color\": \"black\",\n \"licensePlate\": \"123 ABC\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"vehicleCoordinate\": null,\n \"createdAt\": \"2023-03-13T18:05:39.872Z\"\n }\n ],\n \"count\": 3\n}"}],"_postman_id":"569c2df6-6448-4d6a-b18e-4fcb757c7bda"},{"name":"List All Vehicles","id":"42cd8361-a878-4423-8177-ec61c0013ed8","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/vehicles","description":"Returns all active vehicles for the caller’s stores (non-paginated), including their current driver and last known coordinates.
\nReturns an array of vehicle objects.
\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","vehicles"],"host":["{{hostname}}"],"query":[{"disabled":true,"description":{"content":"Repeatable UUID filter. Default: all visible stores.
\n","type":"text/plain"},"key":"storeIds","value":""}],"variable":[]}},"response":[{"id":"ac514095-8a51-4ad5-b1f4-b339e1817480","name":"List All Vehicles response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/vehicles"},"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":"706"},{"key":"ETag","value":"W/\"2c2-to9SwEXO8HLt1t/4+gVfD/MPlbg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Wed, 27 Mar 2024 17:58:06 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"be1a09db-871e-4ada-89c3-4bacc4d69e50\",\n \"driver\": null,\n \"type\": \"CAR\",\n \"enabled\": true,\n \"seats\": 4,\n \"make\": \"Audi\",\n \"model\": \"A3\",\n \"color\": \"yellow\",\n \"licensePlate\": \"123 ABD\",\n \"store\": {\n \"id\": \"495fd56c-6484-4198-bac2-d3ffd4455f4a\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\"\n },\n \"vehicleCoordinate\": null,\n \"createdAt\": \"2024-03-27T17:56:31.432Z\",\n \"passengers\": [\n {\n \"count\": null\n }\n ]\n },\n {\n \"id\": \"3dc64756-b13b-448c-97a1-ce0ba609098b\",\n \"driver\": null,\n \"type\": \"CAR\",\n \"enabled\": true,\n \"seats\": 4,\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"color\": \"black\",\n \"licensePlate\": \"123 ABC\",\n \"store\": {\n \"id\": \"495fd56c-6484-4198-bac2-d3ffd4455f4a\",\n \"name\": \"Alpha Store\",\n \"color\": \"blue\"\n },\n \"vehicleCoordinate\": null,\n \"createdAt\": \"2024-03-27T17:56:31.412Z\",\n \"passengers\": [\n {\n \"count\": null\n }\n ]\n }\n]"}],"_postman_id":"42cd8361-a878-4423-8177-ec61c0013ed8"},{"name":"Get Vehicle","id":"95c32f71-80b0-49f0-9adf-36287c1daa72","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/vehicles/:id","description":"Returns a single vehicle.
\nReturns the vehicle object (type, make, model, seats, color, licensePlate, store, driver, …).
\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","vehicles",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"e3372933-f6c3-4284-88b0-2798fbb8db73","description":{"content":"UUID of the vehicle.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c60b6e3b-a2a3-4c9c-afa3-dd2a72ba086a","name":"Get Vehicle response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/vehicles/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"428"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3f932af4-8440-4fd1-a581-3a68d2160d04\",\n \"type\": \"CAR\",\n \"make\": \"Honda\",\n \"model\": \"Civic\",\n \"seats\": 4,\n \"licensePlate\": \"123 ABC\",\n \"color\": \"black\",\n \"enabled\": true,\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-13T18:05:39.872Z\",\n \"createdBy\": {\n \"id\": \"c6b688ba-03e3-435c-a4dc-2b967f8ec0cf\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null,\n \"vehicleCoordinate\": null\n}"}],"_postman_id":"95c32f71-80b0-49f0-9adf-36287c1daa72"},{"name":"Update Vehicle","id":"0d5f5124-bb0a-4c87-b9ab-bd890a6f291e","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"seats\": 10,\n \"color\": \"Blue\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicles/:id","description":"Updates a vehicle. All fields are optional — only the fields present are changed. Moving a vehicle to a different store is rejected while it has confirmed trips (400 VEHICLE_HAS_ACTIVE_TRIPS).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated vehicle object.
\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","vehicles",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"bb8d227d-9f8e-4b05-8806-bc2a7a846a58","description":{"content":"UUID of the vehicle.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"890dc7ff-1033-4513-be5f-603d490a45fc","name":"Update Vehicle response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"VAN\",\n \"make\": \"Honda\",\n \"model\": \"Accord\",\n \"licensePlate\": \"123 ABC\",\n \"seats\": 5,\n \"color\": \"blue\",\n \"storeId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicles/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"277"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3f932af4-8440-4fd1-a581-3a68d2160d04\",\n \"type\": \"VAN\",\n \"make\": \"Honda\",\n \"model\": \"Accord\",\n \"licensePlate\": \"123 ABC\",\n \"seats\": 5,\n \"color\": \"blue\",\n \"store\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"updatedBy\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"updatedAt\": \"2023-03-15T19:20:34.209Z\"\n}"}],"_postman_id":"0d5f5124-bb0a-4c87-b9ab-bd890a6f291e"},{"name":"Archive Vehicle","id":"94c50493-7872-4ff3-a7d8-ac96ff728e3c","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/vehicles/:id","description":"Soft-deletes (archives) a vehicle. Rejected while the vehicle is claimed by a driver (400 VEHICLE_HAS_DRIVER) or has confirmed trips (400 VEHICLE_HAS_ACTIVE_TRIPS).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the vehicle.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"94c50493-7872-4ff3-a7d8-ac96ff728e3c"},{"name":"Assign Driver","id":"2eef45a4-35da-470d-b4e0-7cbf327b78f1","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"driverId\": \"4be9f1e0-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicles/:id/assignDriver","description":"Assigns (claims) a vehicle for a driver on the driver’s behalf. Rejected if the vehicle already has a driver (400 VEHICLE_HAS_DRIVER) or the driver already holds a vehicle (400 USER_HAS_VEHICLE).
Required role: DISPATCHER or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the vehicle.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2eef45a4-35da-470d-b4e0-7cbf327b78f1"}],"id":"009a804d-e610-470d-a72b-efa97c4ebc93","description":"Manage your fleet. Vehicle types: CAR | VAN | BUS | BICYCLE | SUV.
Creates a message template in a store. Locale rows for en, fr, and es are always created — pass locales to seed their contents (missing languages start empty). The name must be unique within the store (409 MESSAGE_TEMPLATE_NAME_TAKEN).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created template including its three locales.
Returns a paginated list of active message templates for the caller’s stores.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count }.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""}],"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=","host":["{{hostname}}"],"path":["v2","messageTemplates"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"storeId","value":""}]}},"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":"cc7b2987-3212-4225-a58a-437298f934a2"},{"name":"List All MessageTemplates","id":"d79da7c1-d5b0-48fb-96b2-6fd25290fc04","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/messageTemplates?storeId=","description":"Returns all active message templates of a store (non-paginated).
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns an array of template objects with their locales.
Required. The store whose templates to return.
\n","type":"text/plain"},"key":"storeId","value":""}],"variable":[]}},"response":[],"_postman_id":"d79da7c1-d5b0-48fb-96b2-6fd25290fc04"},{"name":"Get MessageTemplate","id":"5f7fdef9-4263-4e03-8658-b08088a5b094","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/messageTemplates/:id","description":"Returns a single message template with its locales.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the template object.
\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","messageTemplates",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"bb3f1642-a99f-43d7-8501-85c79dd84a3c","description":{"content":"UUID of the template.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d1269a3b-de5f-4fa2-a5d6-1fa544fb40e2","name":"Get MessageTemplate response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/messageTemplates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"676"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\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 \"locales\": [\n {\n \"id\": \"975f4fcf-1b17-418b-947d-2811ebf18705\",\n \"language\": \"en\",\n \"template\": \"Hi {{{customerName}}}, your driver is on the way! Track your driver: {{{trackingLink}}}\"\n },\n {\n \"id\": \"f9ac787c-5ba7-44be-8291-14014ebd496d\",\n \"language\": \"fr\",\n \"template\": \"Bonjour {{{customerName}}}, votre chauffeur est on route! {{{trackingLink}}}\"\n }\n ],\n \"createdAt\": \"2023-04-05T14:18:12.041Z\",\n \"createdBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null\n}"}],"_postman_id":"5f7fdef9-4263-4e03-8658-b08088a5b094"},{"name":"Update MessageTemplate","id":"0b8815bd-f6a9-4d4d-a2a8-412bf5206106","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Driver on the way\",\n \"locales\": [\n {\n \"id\": \"0d1e2f30-0000-0000-0000-000000000000\",\n \"template\": \"Your driver is on the way!\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/messageTemplates/:id","description":"Updates a template’s type, name, and/or locale contents. All fields are optional. Locale updates are addressed by the locale row id (from Get MessageTemplate), not by language.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated template object.
\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","messageTemplates",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"8ef97923-e93c-49d4-9b01-fdff21bd4378","description":{"content":"UUID of the template.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"20f9fb7f-a9cc-4760-a5ac-f40b018821dd","name":"Update MessageTemplate response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"SMS\",\n \"name\": \"Driver confirmed message\",\n \"locales\": [{\n \"id\": \"975f4fcf-1b17-418b-947d-2811ebf18705\",\n \"template\": \"Hi {{{customerName}}}, your driver is on the way! Track your driver: {{{trackingLink}}}\"\n },\n {\n \"id\": \"f9ac787c-5ba7-44be-8291-14014ebd496d\",\n \"template\": \"Bonjour {{{customerName}}}, votre chauffeur est on route! {{{trackingLink}}}\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/messageTemplates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"787"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9b9d2dab-688d-42b3-a660-c52a07fa3fe2\",\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 \"locales\": [\n {\n \"id\": \"975f4fcf-1b17-418b-947d-2811ebf18705\",\n \"language\": \"en\",\n \"template\": \"Hi {{{customerName}}}, your driver is on the way! Track your driver: {{{trackingLink}}}\"\n },\n {\n \"id\": \"f9ac787c-5ba7-44be-8291-14014ebd496d\",\n \"language\": \"fr\",\n \"template\": \"Bonjour {{{customerName}}}, votre chauffeur est on route! {{{trackingLink}}}\"\n }\n ],\n \"createdAt\": \"2023-04-05T14:18:12.041Z\",\n \"createdBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": \"2023-04-05T17:07:46.509Z\",\n \"updatedBy\": {\n \"id\": \"b2eeb765-8c35-4ef1-b307-e0c47eda1e78\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n }\n}"}],"_postman_id":"0b8815bd-f6a9-4d4d-a2a8-412bf5206106"},{"name":"Delete MessageTemplate","id":"f422dde9-339d-4dd6-8b27-3519be7a1537","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/messageTemplates/:id","description":"Soft-deletes a message template. Rejected while any active workflow or workflow step still references it (400 MESSAGE_TEMPLATE_IS_IN_USE).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the template.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4404056d-a5a5-495e-8ec4-a3130d9c6f51","name":"Delete MessageTemplate response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/messageTemplates/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f422dde9-339d-4dd6-8b27-3519be7a1537"}],"id":"3f8a83c7-287a-49e0-915b-a6d3c772ba70","description":"Reusable SMS/email message bodies, localized in en, fr, and es, referenced by workflows to notify customers.
Creates a customer in a store and geocodes + attaches the given address as their first place. Either companyName or both firstName and lastName must be provided (400 CUSTOMER_COMPANY_NAME_OR_FIRST_NAME_REQUIRED).
Responds 201 with the created customer and a Location header.
Returns a paginated list of active customers for the caller’s stores.
\nReturns { items, count }.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Free-text search (max 100) over names, company, phone, and email.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Repeatable UUID filter.
\n","type":"text/plain"},"key":"storeIds","value":""}],"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":"15cd6b60-2b8a-4fa4-ab2a-1d3f9d8e2e60"},{"name":"List Archived Customers","id":"a1670ae1-60cd-4c76-914b-89088afd6c41","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customers/archived?page=0&size=10","description":"Returns a paginated list of archived customers, with the same parameters as List Customers.
\nReturns { items, count }.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Free-text search (max 100).
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Repeatable UUID filter.
\n","type":"text/plain"},"key":"storeIds","value":""}],"variable":[]}},"response":[],"_postman_id":"a1670ae1-60cd-4c76-914b-89088afd6c41"},{"name":"Search Customers","id":"843c5493-741c-4cd9-9754-7f439f122a07","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customers/search?phoneNumber=555","description":"Quick lookup returning at most 5 matching active customers, newest first. At least one search field is required.
\nReturns an array of up to 5 customers: id, firstName, lastName, companyName, email, language, phoneNumber, notes, smsEnabled.
Substring match on phone number.
\n","type":"text/plain"},"key":"phoneNumber","value":"555"},{"disabled":true,"description":{"content":"Case-insensitive substring match.
\n","type":"text/plain"},"key":"companyName","value":""},{"disabled":true,"description":{"content":"Case-insensitive substring match.
\n","type":"text/plain"},"key":"firstName","value":""},{"disabled":true,"description":{"content":"Case-insensitive substring match.
\n","type":"text/plain"},"key":"lastName","value":""},{"disabled":true,"description":{"content":"Substring match.
\n","type":"text/plain"},"key":"email","value":""}],"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":"843c5493-741c-4cd9-9754-7f439f122a07"},{"name":"Get Customer","id":"533cb49f-6b44-4c15-a271-cc0a95fbc3d0","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customers/:id","description":"Returns a single customer with their saved places.
\nReturns the customer object.
\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","customers",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"3e161fcd-0e82-4968-b7e8-2f8328ecc726","description":{"content":"UUID of the customer.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"53573a08-e06d-4f02-ae20-535c60a0976f","name":"Get Customer response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/customers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"546"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"802096bb-8a82-4d8b-86a9-72069ac6705e\",\n \"firstName\": \"Noel\",\n \"lastName\": \"Sky\",\n \"email\": \"\",\n \"language\": \"en\",\n \"companyName\": \"\",\n \"phoneNumber\": \"555 123 1234\",\n \"store\": {\n \"id\": \"f1a04c8a-dc36-4203-9a9e-698e06cf7cef\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-03-14T15:32:01.226Z\",\n \"createdBy\": {\n \"id\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null,\n \"places\": [\n {\n \"id\": \"82afc9d1-bc18-4bc9-af3a-65015456ee95\",\n \"address\": \"3901 Bannantyne, Verdun, QC H4G 1C2\",\n \"createdAt\": \"2023-03-13T19:57:55.972Z\"\n }\n ]\n}"}],"_postman_id":"533cb49f-6b44-4c15-a271-cc0a95fbc3d0"},{"name":"Update Customer","id":"1deea88e-0a5f-4b86-9820-9293a775141c","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"phoneNumber\": \"+1 514 555 0199\",\n \"notes\": \"Prefers front seat.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customers/:id","description":"Updates a customer. All fields are optional — only the fields present are changed.
\nReturns the updated customer object.
\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","customers",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"113e5bf2-89ee-433b-bc68-445d9d4ea85f","description":{"content":"UUID of the customer.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a8dadcd4-e199-48c6-9774-e4ae034e3c22","name":"Update Customer response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Charlie\",\n \"lastName\": \"Adams\",\n \"companyName\": \"ACME Inc.\",\n \"language\": \"en\",\n \"email\": \"\",\n \"phoneNumber\": \"555 123 3456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"258"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\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 \"updatedBy\": \"7b5f6ea6-7b3a-4437-838a-9a31994aacb3\",\n \"updatedAt\": \"2023-03-15T15:31:20.048Z\"\n}"}],"_postman_id":"1deea88e-0a5f-4b86-9820-9293a775141c"},{"name":"Archive Customer","id":"712568d4-31ff-492c-9104-2d591220103c","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/customers/:id","description":"Soft-deletes (archives) a customer. Responds 400 if the customer is already archived.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the customer.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"712568d4-31ff-492c-9104-2d591220103c"},{"name":"Batch Archive Customers","id":"2855caca-6134-4f99-9f24-213d490cf1e0","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerIds\": [\n \"e1f2a3b4-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/customers/batchArchive","description":"Archives up to 50 customers in one call.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
Restores up to 50 archived customers in one call.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
Bulk-imports 1–10 000 customers into a store. The import runs asynchronously — the request returns immediately.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content; the import continues in the background.
Starts a background scan that merges duplicate customers in a store and emails the caller a CSV report when done. Rate-limited: one run per user every 5 minutes (429 CUSTOMER_DEDUPLICATION_COOLDOWN).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 202 Accepted with a confirmation message.
Saves an address as a place on a customer. The address is geocoded (or matched to an existing place of the store) and linked to the customer.
\nResponds 201 with the place when newly linked, or 204 when the customer already had it.
Unlinks a saved place from a customer. The place itself is not deleted.
\nResponds 204 No Content.
UUID of the customer.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"c4e8ecce-666b-45db-97c0-7fd03ce0c0ff","description":{"content":"UUID of the place to unlink.
\n","type":"text/plain"},"type":"any","value":"","key":"placeId"}]}},"response":[{"id":"badfcd13-e958-4649-9e04-07338bd8c6ef","name":"Delete Customer Place response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/customers//places/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","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":"Date","value":"Tue, 12 Mar 2024 17:58:12 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"64cf1724-a29b-4846-b605-f36bfacea377"}],"id":"c240f06f-2c5e-45ae-9987-7e3431d831ca","description":"The people you shuttle. Customers belong to a store and can hold multiple saved places.
\n","_postman_id":"c240f06f-2c5e-45ae-9987-7e3431d831ca","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":"3e259b60-71df-48f1-9887-712d3a7ebac2","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews?page=0&size=10","description":"Returns a paginated list of reviews for the caller’s stores, with rich filtering and sorting.
\nReturns { items, count } — each item includes rating, comment, createdAt, and the associated trip (customer, store, drivers, workflow, dispatcher).
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"ISO 8601 window start (with endDate).
ISO 8601 window end (with startDate).
Filter by the dispatcher who created the trip.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Filter by an assigned driver.
\n","type":"text/plain"},"key":"driverId","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"Free-text search (max 100) over trip reference, customer name/phone, and review comment.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Exact rating filter, 1–5.
\n","type":"text/plain"},"key":"rating","value":""},{"disabled":true,"description":{"content":"recent (default) | highest | lowest.
Returns a single review.
\nReturns { id, trip: { id }, rating, comment, createdAt }.
UUID of the review.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"56f66523-0bba-4528-828b-6b1475d998a4","name":"Get Customer Review","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews/"},"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":"213"},{"key":"ETag","value":"W/\"d5-7xXAVndLZ3s/l98j1l6g1u3xXLA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 15 Mar 2024 13:31:14 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\": {\n \"id\": \"5b223143-15a1-47d5-aacf-8164ddb030eb\"\n },\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":"722ea09f-807d-42cf-8691-9d4a7a66cfdb"},{"name":"Get Driver Rating","id":"6c6074bd-9a0a-4099-8966-70e32df8c34a","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews/rating/:driverId/:limit","description":"Returns a driver’s average rating over their most recent reviews.
\nReturns { rating } — a number rounded to one decimal, or null when the driver has no reviews.
UUID of the driver.
\n","type":"text/plain"},"type":"any","value":"","key":"driverId"},{"id":"8ef71e9a-82a9-496f-a3c5-337e5b2fb598","description":{"content":"How many most-recent reviews to average (integer ≥ 1).
\n","type":"text/plain"},"type":"any","value":"25","key":"limit"}]}},"response":[],"_postman_id":"6c6074bd-9a0a-4099-8966-70e32df8c34a"},{"name":"Review Analytics","id":"f2fa50e3-60de-419f-8e61-affa46ab1f0f","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/customerReviews/analytics?startDate=2026-07-01T00:00:00.000Z&endDate=2026-07-31T23:59:59.000Z&granularity=day&timezoneOffset=-240","description":"Returns per-store review-rating time series (bucketed by the chosen granularity) plus an aggregate, for the given window.
\nReturns { stores: [{ name, color, data }], aggregate }.
Required. ISO 8601 window start.
\n","type":"text/plain"},"key":"startDate","value":"2026-07-01T00:00:00.000Z"},{"description":{"content":"Required. ISO 8601 window end.
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"description":{"content":"Required. day | week | month.
Required. Caller’s UTC offset in minutes.
\n","type":"text/plain"},"key":"timezoneOffset","value":"-240"},{"disabled":true,"description":{"content":"Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter by creating dispatcher.
\n","type":"text/plain"},"key":"dispatcherId","value":""},{"disabled":true,"description":{"content":"Filter by an assigned driver.
\n","type":"text/plain"},"key":"driverId","value":""},{"disabled":true,"description":{"content":"Filter by workflow.
\n","type":"text/plain"},"key":"workflowId","value":""},{"disabled":true,"description":{"content":"Free-text search (max 100).
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Exact rating filter, 1–5.
\n","type":"text/plain"},"key":"rating","value":""}],"variable":[]}},"response":[],"_postman_id":"f2fa50e3-60de-419f-8e61-affa46ab1f0f"},{"name":"Delete Customer Review","id":"8d6c5b01-7359-416a-802a-8c95cb0386ba","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/customerReviews/:id","description":"Permanently deletes a review.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the review.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0b6291c8-cf16-437f-9e76-5ec77bd2dc89","name":"Delete Customer Review","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/customerReviews/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","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":"Date","value":"Fri, 15 Mar 2024 13:50:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8d6c5b01-7359-416a-802a-8c95cb0386ba"}],"id":"0ac1d96a-9146-42a4-905c-29df490d722c","description":"Star ratings (1–5) and comments customers leave after completed trips. Reviews are created by customers from the trip-tracking page; through the API you can list, analyze, and moderate them.
\n","_postman_id":"0ac1d96a-9146-42a4-905c-29df490d722c","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 Favorite Place","id":"7c2dd22d-1290-42d8-b8c0-23555f29eca9","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"storeId\": \"9f2d1c34-0000-0000-0000-000000000000\",\n \"address\": \"900 Airport Rd, Dorval, QC\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/places","description":"Geocodes an address and saves it as a favorite place of a store.
\nResponds 201 with the created place (id, address, latitude, longitude, isFavorite).
Returns a paginated list of favorite places, including which workflows use each place.
\nReturns { items, count } — each item includes store.name and workflowSteps[].workflow references.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Case-insensitive substring match on the address.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter to one store. Default: all visible stores.
\n","type":"text/plain"},"key":"storeId","value":""}],"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=","host":["{{hostname}}"],"path":["v2","places"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"storeId","value":""}]}},"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":"3341788c-eba8-4942-9a80-19da530fbe22"},{"name":"List All Places","id":"079546a0-6144-4e74-be2b-d697cab6270d","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/places?storeId=","description":"Returns all favorite places of a store (non-paginated), newest first.
\nReturns an array of { id, address, latitude, longitude, isFavorite, createdAt }.
Required. The store whose favorite places to return.
\n","type":"text/plain"},"key":"storeId","value":""}],"variable":[]}},"response":[{"id":"a36b1e81-0ad1-4740-8e06-3c60c336b56d","name":"List All Places response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{hostname}}/v2/places?storeId=","host":["{{hostname}}"],"path":["v2","places"],"query":[{"key":"storeId","value":""}]}},"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":"200"},{"key":"ETag","value":"W/\"c8-8GAF5cIq+mtF5vZuTb7myKHdWr8\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 18 Mar 2024 18:53:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"828fc62a-f64c-4ba6-a525-4165d1a7846f\",\n \"address\": \"Saint Joseph's Oratory of Mount Royal\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"isFavorite\": true,\n \"createdAt\": \"2024-03-14T19:06:04.251Z\"\n }\n]"}],"_postman_id":"079546a0-6144-4e74-be2b-d697cab6270d"},{"name":"Get Place","id":"9755d187-f772-4423-b2ea-e47de55ed009","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/places/:id","description":"Returns a single place.
\nReturns the place object.
\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","places",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"dac56cba-5f57-452c-a580-a90e56b629ef","description":{"content":"UUID of the place.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c167f24b-cbcf-4b11-a25a-9768c03fa135","name":"Get Place response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/places/"},"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":"255"},{"key":"ETag","value":"W/\"ff-eOZLS0iHuDtmKbhzTY0S/ISdxxE\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 18 Mar 2024 18:54:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"828fc62a-f64c-4ba6-a525-4165d1a7846f\",\n \"address\": \"Saint Joseph's Oratory of Mount Royal\",\n \"latitude\": 45.4919122,\n \"longitude\": -73.6186555,\n \"store\": {\n \"id\": \"e81f65c4-5cf7-4339-b6f8-437bc9cd42b7\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2024-03-14T19:06:04.251Z\"\n}"}],"_postman_id":"9755d187-f772-4423-b2ea-e47de55ed009"},{"name":"Favorite Place","id":"0f37d7e4-021a-487c-856b-46f4bf1c24df","request":{"method":"POST","header":[],"url":"{{hostname}}/v2/places/favorite/:id","description":"Marks an existing place as a favorite of its store.
\nReturns the place object with isFavorite: true.
UUID of the place.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"933e4671-102c-4bb6-9dd4-cf138317cbd7","name":"Favorite Place response","originalRequest":{"method":"POST","header":[],"url":"{{hostname}}/v2/places/favorite/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"275"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\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 \"store\": {\n \"id\": \"0b8a26d9-14f3-40ae-8d44-681e0b5c381a\",\n \"name\": \"Alpha Store\"\n },\n \"createdAt\": \"2023-04-06T17:07:28.032Z\",\n \"isFavorite\": true\n}"}],"_postman_id":"0f37d7e4-021a-487c-856b-46f4bf1c24df"},{"name":"Unfavorite Place","id":"889f46be-fa32-4381-b72b-db4726e298ee","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/places/:id","description":"Removes a place from the store’s favorites. Rejected while any workflow step uses the place (400 PLACE_HAS_WORKFLOW). The place itself is kept (it may be referenced by past trips).
Responds 204 No Content.
UUID of the place.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bb9682fb-edf6-4e47-8bf8-8f1af3f0b041","name":"Unfavorite Place response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/places/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"889f46be-fa32-4381-b72b-db4726e298ee"},{"name":"List Favorite Places by Kiosk","id":"1107c022-ea05-4f66-a5b5-9543cf56d8d2","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/places/favorites/:kioskShortUrl","description":"Returns the favorite places of the store that owns the given kiosk — the destination quick-picks shown on that kiosk.
\nReturns an array of { id, address, latitude, longitude, isFavorite, createdAt }.
The kiosk’s short URL code (max 10 characters).
\n","type":"text/plain"},"type":"any","value":"","key":"kioskShortUrl"}]}},"response":[],"_postman_id":"1107c022-ea05-4f66-a5b5-9543cf56d8d2"}],"id":"f57f6d4b-ba5e-44e0-8d03-e4bf6f3743ea","description":"Geocoded addresses. “Favorite” places belong to a store and appear as quick-pick destinations; customers also hold their own saved places (see the Customers folder).
\n","_postman_id":"f57f6d4b-ba5e-44e0-8d03-e4bf6f3743ea","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":"780153f5-f470-46ff-9dca-bdc7db6418d1","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Downtown\",\n \"geometry\": \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-73.58,45.49],[-73.55,45.49],[-73.55,45.51],[-73.58,45.51],[-73.58,45.49]]]}\",\n \"color\": \"#1677ff\",\n \"storeIds\": [\n \"9f2d1c34-0000-0000-0000-000000000000\"\n ],\n \"restricted\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/zones","description":"Creates a zone and assigns it to one or more stores. Existing active trips whose places fall inside the polygon are tagged with the new zone automatically.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created zone.
Returns a paginated list of zones visible to the caller.
\nReturns { items, count }.
Required. Zero-based page index.
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Page size, 1–100. Default 10.
Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"normal (default — unrestricted zones), restricted, or all.
Returns all zones for the given stores (non-paginated).
\nReturns an array of zone objects, each with its stores.
Repeatable UUID filter. Default: all visible stores.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"normal (default), restricted, or all.
Returns stores with their zones nested — convenient for grouped drop-down filters.
\nReturns an array of stores, each with a zones array.
Repeatable UUID filter. Default: all visible stores.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"normal (default), restricted, or all.
Returns a single zone.
\nReturns { id, name, color, geometry, restricted, stores, createdAt, createdBy, updatedAt, updatedBy }.
UUID of the zone.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bb70f428-9395-4370-9212-344797c4a774","name":"Get Zone response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/zones/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"387"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\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}"}],"_postman_id":"f61a9f61-dc47-4cd2-88a5-b6ae707abda4"},{"name":"Update Zone","id":"b68ccf03-ce78-44ed-9646-d32ebf5f7741","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Downtown\",\n \"geometry\": \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-73.58,45.49],[-73.55,45.49],[-73.55,45.51],[-73.58,45.51],[-73.58,45.49]]]}\",\n \"color\": \"#1677ff\",\n \"storeIds\": [\n \"9f2d1c34-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/zones/:id","description":"Replaces a zone’s definition and store assignments.
\nResponds 204 No Content.
UUID of the zone.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6c14a136-e5cc-46a7-b693-4a4d83cb1694","name":"Update Zone response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"geometry\": \"pmk`M{eytGguCdmArlChqB|pCg|AihCgbB\",\n \"name\": \"Alpha Store Zone\",\n \"color\": \"blue\",\n \"storeId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/zones/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","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":"ETag","value":"W/\"a-bAsFyilMr4Ra1hIU5PyoyFRunpI\""},{"key":"Date","value":"Wed, 28 Feb 2024 16:45:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b68ccf03-ce78-44ed-9646-d32ebf5f7741"},{"name":"Delete Zone","id":"6a2f7c98-b1f8-4160-a37b-289c74a867ce","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/zones/:id","description":"Soft-deletes a zone and detaches it from active trips. Rejected while a confirmed trip is using the zone (400 ZONE_IS_IN_USE).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the zone.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"33990cb0-8523-4941-bd64-bccb59176456","name":"Delete Zone response","originalRequest":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/zones/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6a2f7c98-b1f8-4160-a37b-289c74a867ce"}],"id":"7da72371-3896-4bd3-a031-3d52d8138b5d","description":"Geographic polygons attached to one or more stores. Zones tag trips for filtering/analytics; restricted zones limit where kiosk trips may go.
Creates a kiosk for a store. A unique short URL is generated automatically.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created kiosk (including its generated shortUrl).
Returns a paginated list of active kiosks for the caller’s stores.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count } — each item includes shortUrl, notice settings, tripStates, store, and workflows.
Zero-based page index. Default 0.
Page size, 1–100. Default 10.
Repeatable UUID filter.
\n","type":"text/plain"},"key":"storeIds","value":""},{"disabled":true,"description":{"content":"Case-insensitive substring match on the kiosk name (max 100).
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"bf509b91-eb11-454f-ac61-e954f44e0e2f"},{"name":"Grouped Kiosks","id":"36a73e19-2d76-4f5b-a0cf-53ce27b8da40","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/kiosks/grouped","description":"Returns stores with their kiosks nested — convenient for grouped drop-downs.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns an array of stores, each with a kiosks array of { id, name }.
Filter to one store. Default: all visible stores.
\n","type":"text/plain"},"key":"storeId","value":""}],"variable":[]}},"response":[],"_postman_id":"36a73e19-2d76-4f5b-a0cf-53ce27b8da40"},{"name":"Get Kiosk","id":"7870ed72-538b-4800-b42b-5c33c9eacd8c","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/kiosks/:id","description":"Returns a single kiosk with its workflows, availability windows, and theming. When the kiosk is connected to a point of sale, the response also includes the POS’s Stripe products.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the kiosk object.
\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","kiosks",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"134230ca-f1a3-47c2-9eb4-a58d6c89dd9f","description":{"content":"UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"7870ed72-538b-4800-b42b-5c33c9eacd8c"},{"name":"Update Kiosk","id":"5c544a15-2099-43b4-8a11-795da0355262","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"shortUrl\": \"a1B2c3\",\n \"name\": \"Lobby kiosk\",\n \"description\": \"Book your shuttle to the airport.\",\n \"enabledWorkflowIds\": [\n \"7ab30e12-0000-0000-0000-000000000000\"\n ],\n \"tripStates\": [\n \"SCHEDULED\"\n ],\n \"minimumNotice\": 1,\n \"maximumNotice\": 336,\n \"returnTripEnabled\": true,\n \"maximumSeats\": 4,\n \"tripRestrictionZoneId\": null,\n \"lightHeadingFontColor\": \"\",\n \"lightTextFontColor\": \"\",\n \"lightBackgroundColor\": \"\",\n \"darkHeadingFontColor\": \"\",\n \"darkTextFontColor\": \"\",\n \"darkBackgroundColor\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/kiosks/:id","description":"Replaces a kiosk’s settings. All fields are required (send current values for anything you don’t want to change); the workflow assignment is replaced by enabledWorkflowIds.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"5c544a15-2099-43b4-8a11-795da0355262"},{"name":"Delete Kiosk","id":"e63051a1-12e3-46bd-a2a9-dc8b804f3abc","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/kiosks/:id","description":"Permanently deletes a kiosk. Rejected while the kiosk is connected to an active point of sale (400 KIOSK_CONNECTED_TO_POS).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e63051a1-12e3-46bd-a2a9-dc8b804f3abc"},{"name":"Regenerate Kiosk Short URL","id":"4c52d14f-ab6d-46fa-949a-2e3fb751f6d9","request":{"method":"POST","header":[],"url":"{{hostname}}/v2/kiosks/:id/generateShortUrl","description":"Replaces the kiosk’s short URL with a newly generated one, invalidating the old link.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content. Fetch the kiosk to read the new shortUrl.
UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4c52d14f-ab6d-46fa-949a-2e3fb751f6d9"},{"name":"Create Kiosk Availability","id":"d31bab3b-9b0c-423d-9e78-bda28a1d253d","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dayOfWeek\": 1,\n \"startTime\": \"08:00\",\n \"endTime\": \"18:00\",\n \"availableSeats\": 40,\n \"availableTrips\": 10\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/kiosks/:id/availabilities","description":"Adds a weekly availability window to a kiosk. When a kiosk has any windows, scheduled bookings are only accepted inside them (and per-window seat/trip caps are enforced).
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created availability window.
UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d31bab3b-9b0c-423d-9e78-bda28a1d253d"},{"name":"Update Kiosk Availability","id":"a376623f-e7bd-4f7a-a295-2d3bcb36e71f","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dayOfWeek\": 1,\n \"startTime\": \"09:00\",\n \"endTime\": \"17:00\",\n \"availableSeats\": null,\n \"availableTrips\": 8\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/kiosks/:id/availabilities/:availabilityId","description":"Replaces an availability window’s definition.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated availability window.
\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","kiosks",":id","availabilities",":availabilityId"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"acd7739b-7efc-4c75-bf68-65a210697d5c","description":{"content":"UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"id":"9a403b16-b17d-4227-b998-8fb9596bf0f9","description":{"content":"UUID of the availability window.
\n","type":"text/plain"},"type":"any","value":"","key":"availabilityId"}]}},"response":[],"_postman_id":"a376623f-e7bd-4f7a-a295-2d3bcb36e71f"},{"name":"Delete Kiosk Availability","id":"62292289-e620-469e-9223-8d8e6fcd7609","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/kiosks/:id/availabilities/:availabilityId","description":"Removes an availability window from a kiosk.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the kiosk.
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"id":"863f4834-2f41-4e8f-a4ac-4698a013c74c","description":{"content":"UUID of the availability window.
\n","type":"text/plain"},"type":"any","value":"","key":"availabilityId"}]}},"response":[],"_postman_id":"62292289-e620-469e-9223-8d8e6fcd7609"}],"id":"37e3298b-1e09-43b7-90c2-c681064f808a","description":"Self-serve booking kiosks. Each kiosk belongs to a store, exposes a subset of the store’s workflows, and is reached by customers through its short URL. Optional weekly availability windows cap when (and how many) trips can be booked.
\n","_postman_id":"37e3298b-1e09-43b7-90c2-c681064f808a","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":"UserSchedules","item":[{"name":"Create UserSchedule","id":"a2bc6ea7-95e7-49fd-9b71-2c45a461e6d7","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"4be9f1e0-0000-0000-0000-000000000000\",\n \"startAt\": \"2026-08-03T12:00:00.000Z\",\n \"endAt\": \"2026-08-03T20:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/userSchedules","description":"Creates a shift for a user.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created schedule.
Returns schedules for the caller’s stores (non-paginated), optionally narrowed to one user or one day.
\nReturns an array of schedule objects (id, user, startAt, endAt).
ISO 8601 date — return only shifts overlapping that day.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter to one user.
\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"Repeatable UUID store filter.
\n","type":"text/plain"},"key":"storeIds","value":""}],"variable":[]}},"response":[],"_postman_id":"2c0c4b6c-5e3e-4440-a2b2-c02d50a0bc67"},{"name":"Get UserSchedule","id":"4e75df7c-b1c1-4fea-b3a2-93716485f7b1","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/userSchedules/:id","description":"Returns a single schedule.
\nReturns the schedule object.
\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","userSchedules",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"2b3d3e9c-6400-442c-a1e6-50dbb293594d","description":{"content":"UUID of the schedule.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4e75df7c-b1c1-4fea-b3a2-93716485f7b1"},{"name":"Update UserSchedule","id":"e7fbbb3d-c50e-4319-b95d-3196dc691a3a","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"startAt\": \"2026-08-03T13:00:00.000Z\",\n \"endAt\": \"2026-08-03T21:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/userSchedules/:id","description":"Replaces a shift’s start and end times.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the schedule.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e7fbbb3d-c50e-4319-b95d-3196dc691a3a"},{"name":"Delete UserSchedule","id":"b351465f-a2ce-4b40-a7dd-0a2bfe6c09b9","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/userSchedules/:id","description":"Deletes a single shift.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the schedule.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"b351465f-a2ce-4b40-a7dd-0a2bfe6c09b9"},{"name":"Delete All Schedules For User","id":"ffa407db-cbd0-481b-b906-19bbc77cf7ff","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/userSchedules/forUser/:id","description":"Deletes every shift belonging to the given user.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the user whose shifts to delete.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ffa407db-cbd0-481b-b906-19bbc77cf7ff"}],"id":"c91c7381-b71d-4e95-ab5e-6243884152c9","description":"Work shifts for your staff. Auto-dispatch uses driver schedules to decide who can take a trip, so creating/updating/deleting a schedule re-runs auto-dispatch for that user.
\n","_postman_id":"c91c7381-b71d-4e95-ab5e-6243884152c9","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":"VehicleDriverLogs","item":[{"name":"Create VehicleDriverLog","id":"bdfdc1e2-db76-407f-a631-9a7a7bb18322","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vehicle\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n \"driver\": \"4be9f1e0-0000-0000-0000-000000000000\",\n \"claimedAt\": \"2026-07-28T12:00:00.000Z\",\n \"releasedAt\": \"2026-07-28T20:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicleDriverLogs","description":"Manually records a vehicle-possession entry (e.g. to backfill a missed claim).
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created log entry.
Returns log entries overlapping the given window for the caller’s stores. Pagination is optional — omit page/size to get all matches.
Returns { items, count } — each item includes the vehicle, driver, claimedAt, releasedAt, and duration (seconds).
Required. ISO 8601 window start.
\n","type":"text/plain"},"key":"startDate","value":"2026-07-01T00:00:00.000Z"},{"description":{"content":"Required. ISO 8601 window end.
\n","type":"text/plain"},"key":"endDate","value":"2026-07-31T23:59:59.000Z"},{"disabled":true,"description":{"content":"Zero-based page index (optional).
\n","type":"text/plain"},"key":"page","value":"0"},{"disabled":true,"description":{"content":"Page size, 1–100 (optional).
\n","type":"text/plain"},"key":"size","value":"10"},{"disabled":true,"description":{"content":"Filter to one store.
\n","type":"text/plain"},"key":"storeId","value":""},{"disabled":true,"description":{"content":"Filter to one driver.
\n","type":"text/plain"},"key":"driverId","value":""}],"variable":[]}},"response":[],"_postman_id":"0e24ee7f-c7c6-4f02-8268-0cc9858d8532"},{"name":"Get VehicleDriverLog","id":"4db6e6e1-a14b-4734-a401-a008f2d7d656","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/vehicleDriverLogs/:id","description":"Returns a single log entry.
\nReturns the log entry object.
\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","vehicleDriverLogs",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"994858d4-4608-4beb-b448-80f8f65bf597","description":{"content":"UUID of the log entry.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4db6e6e1-a14b-4734-a401-a008f2d7d656"},{"name":"Update VehicleDriverLog","id":"b7525dd4-8004-45ef-814b-b899744b360b","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"vehicle\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n \"claimedAt\": \"2026-07-28T12:30:00.000Z\",\n \"releasedAt\": \"2026-07-28T20:00:00.000Z\",\n \"duration\": 27000\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/vehicleDriverLogs/:id","description":"Corrects a log entry. duration is recomputed server-side from claimedAt/releasedAt.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the updated log entry.
\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","vehicleDriverLogs",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"71852e25-9053-424a-bf16-784990521689","description":{"content":"UUID of the log entry.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"b7525dd4-8004-45ef-814b-b899744b360b"},{"name":"Delete VehicleDriverLog","id":"f1812264-09f6-4baa-a0fa-39e13a387a1d","request":{"method":"DELETE","header":[],"url":"{{hostname}}/v2/vehicleDriverLogs/:id","description":"Permanently deletes a log entry.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the log entry.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f1812264-09f6-4baa-a0fa-39e13a387a1d"}],"id":"11def3ee-5144-49d7-95c8-2416bdc6222b","description":"The audit log of which driver held which vehicle and when. Entries are created automatically when drivers claim/release vehicles; these endpoints let you list them and make manual corrections.
\n","_postman_id":"11def3ee-5144-49d7-95c8-2416bdc6222b","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":"d40e5437-e779-4f81-ba4f-58163a531627","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"points\": [\n {\n \"latitude\": 45.5019,\n \"longitude\": -73.5674\n },\n {\n \"latitude\": 45.4706,\n \"longitude\": -73.7408\n }\n ],\n \"steps\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/osrm/route","description":"Computes the driving route through the given points, in order.
\nReturns the OSRM route response: routes[] with distance (meters), duration (seconds), and geometry.
Road routing powered by OSRM.
\n","_postman_id":"6a823a7b-36e0-4c63-b88d-ea3c6cb8c6c0","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":"9910aa3d-7c3e-456c-9750-0bde4c47a043","request":{"method":"GET","header":[],"url":"{{hostname}}/v2/stores","description":"Returns every active store visible to the caller.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count, total, storeLimit } — total is the account-wide store count and storeLimit your plan’s cap (0 = unlimited).
Returns the account’s archived stores.
\nRequired role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { items, count }.
Creates a store. The address is geocoded into the store’s home place. The name must be unique on the account (409 STORE_NAME_TAKEN); plan store limits apply (400 STORE_LIMIT_REACHED). The caller and the account owner are automatically assigned to the new store.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 201 with the created store (including its geocoded place).
Returns a single store with its place, settings, and zones.
\nReturns the store object.
\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","stores",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"1e6c4b4b-7d8c-4dfb-a289-7f8cb34141d9","description":{"content":"UUID of the store.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"16affedd-637c-46b4-a646-263c97dd98ed","name":"Get Store response","originalRequest":{"method":"GET","header":[],"url":"{{hostname}}/v2/stores/"},"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":"580"},{"key":"ETag","value":"W/\"244-tVEXedyp76BGVhfr7mxQkjEYxDo\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Tue, 09 Apr 2024 14:40:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4554e868-2e21-4cdf-b9f4-378a3254565f\",\n \"name\": \"Bravo Store\",\n \"color\": \"blue\",\n \"enabled\": true,\n \"iconUrl\": null,\n \"liveTVShortUrl\": \"\",\n \"liveTVWaypoints\": [],\n \"kioskShortUrl\": \"\",\n \"autoDispatchEnabled\": false,\n \"kioskTripsPending\": false,\n \"place\": {\n \"id\": \"3b18c62e-ceb2-490b-9a1e-2c0d65157918\",\n \"address\": \"3901 Bannantyne Ave, Verdun, QC H4G 1B9\",\n \"latitude\": 45.4651629,\n \"longitude\": -73.5756481\n },\n \"radiusBound\": null,\n \"createdAt\": \"2024-03-27T17:56:31.362Z\",\n \"createdBy\": {\n \"id\": \"e8c091d9-5303-411f-9c1b-05acbe8a6496\",\n \"firstName\": \"Edward\",\n \"lastName\": \"Maxedon\"\n },\n \"updatedAt\": null,\n \"updatedBy\": null,\n \"zones\": []\n}"}],"_postman_id":"e223d832-3802-40aa-b803-a973459a8dd9"},{"name":"Update Store","id":"7f7500b8-2b58-4d27-8bc9-73cfaaba7c50","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Downtown branch\",\n \"color\": \"#1677ff\",\n \"address\": \"1 Main St, Montreal, QC\",\n \"radiusBound\": 50,\n \"allowTripOutsideRadius\": true,\n \"autoDispatchEnabled\": true,\n \"autoDispatchScheduledTripEnabled\": false,\n \"overbookingPreventionEnabled\": false,\n \"users\": [\n \"4be9f1e0-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/stores/:id","description":"Replaces a store’s settings and (non-owner) user assignments. Changing address geocodes a new home place and repoints workflow steps that used the old one. users is the full replacement set of assigned users — the owner is always kept.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns { place } — the store’s (possibly new) home place.
UUID of the store.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3ddf6039-a16d-402c-bdcb-92d32412ecdf","name":"Update Store response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"addDefaultWorkflows\": true,\n \"name\": \"Silverline Motors\",\n \"color\": \"skyblue\",\n \"address\": \"1234 Oakwood Drive, Grandview, CA 90210\",\n \"radiusBound\": 50,\n \"kioskTripsPending\": true,\n \"autoDispatchEnabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/stores/"},"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":"214"},{"key":"ETag","value":"W/\"d6-zwkrVRa7v7L6NTcGyL/drTaFX1A\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Tue, 09 Apr 2024 14:44:02 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"place\": {\n \"store\": \"4554e868-2e21-4cdf-b9f4-378a3254565f\",\n \"latitude\": 34.1030032,\n \"longitude\": -118.4104684,\n \"address\": \"1234 Oakwood Drive, Grandview, CA 90210\",\n \"isFavorite\": true,\n \"createdAt\": \"2024-04-09T14:44:02.529Z\"\n }\n}"}],"_postman_id":"7f7500b8-2b58-4d27-8bc9-73cfaaba7c50"},{"name":"Archive Store","id":"6b8b9064-b151-4e48-9ed6-9733ecaca8c5","request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"transferToStoreId\": \"9f2d1c34-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/stores/:id/archive","description":"Archives a store. Rejected while the store has active trips (400 STORE_HAS_ACTIVE_TRIPS). All claimed vehicles are released; users whose only store this was are moved to transferToStoreId, everyone else is simply unassigned.
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Responds 204 No Content.
UUID of the store to archive.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0921d1a9-7d3f-4b8f-a9cc-726853330725","name":"Archive Store response","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"transferToStoreId\": \"495fd56c-6484-4198-bac2-d3ffd4455f4a\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/v2/stores/35772dfa-81cf-40ab-a6c1-30fb54797e60/archive"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","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":"Date","value":"Mon, 08 Apr 2024 19:52:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6b8b9064-b151-4e48-9ed6-9733ecaca8c5"},{"name":"Restore Store","id":"296cb88f-d1b3-4376-a3ed-91547731733d","request":{"method":"POST","header":[],"url":"{{hostname}}/v2/stores/:id/restore","description":"Restores an archived store, assigning the caller (and the account owner) to it. Plan store limits apply (400 STORE_LIMIT_REACHED).
Required role: ADMIN or higher. An account API key always satisfies this (it authenticates as the account owner).
Returns the restored store object.
\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","stores",":id","restore"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"95642fb5-e79d-42df-b8b7-14155fad0e35","description":{"content":"UUID of the store to restore.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"478f7ee0-dd19-45c3-a084-18fa32f46109","name":"Restore Store response","originalRequest":{"method":"POST","header":[],"url":"{{hostname}}/v2/stores//restore"},"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":"309"},{"key":"ETag","value":"W/\"135-+8i2gzujqAop+Ur/0zFjZzXDFis\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Tue, 09 Apr 2024 14:38:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4554e868-2e21-4cdf-b9f4-378a3254565f\",\n \"enabled\": false,\n \"account\": {\n \"id\": \"ee05a9bb-fd36-4805-bd05-cd8f48c0e03a\"\n },\n \"name\": \"Bravo Store\",\n \"radiusBound\": null,\n \"place\": {\n \"id\": \"3b18c62e-ceb2-490b-9a1e-2c0d65157918\",\n \"latitude\": 45.4651629,\n \"longitude\": -73.5756481,\n \"address\": \"3901 Bannantyne Ave, Verdun, QC H4G 1B9\"\n }\n}"}],"_postman_id":"296cb88f-d1b3-4376-a3ed-91547731733d"}],"id":"fe6246e7-52e8-4983-81c8-91e85396db5a","description":"Stores are your dispatch locations. Users, vehicles, customers, workflows, and trips all belong to a store.
\n","_postman_id":"fe6246e7-52e8-4983-81c8-91e85396db5a","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}}"}]}},"variable":[{"key":"page","value":"0"},{"key":"size","value":"5"},{"key":"messageType","value":"\"SMS\""},{"key":"availabilityId","value":""},{"key":"customerId","value":""},{"key":"customerReviewId","value":""},{"key":"driverId","value":""},{"key":"kioskId","value":""},{"key":"kioskShortUrl","value":""},{"key":"messageTemplateId","value":""},{"key":"placeId","value":""},{"key":"stepId","value":""},{"key":"storeId","value":""},{"key":"tripId","value":""},{"key":"userId","value":""},{"key":"userScheduleId","value":""},{"key":"vehicleDriverLogId","value":""},{"key":"vehicleId","value":""},{"key":"workflowId","value":""},{"key":"zoneId","value":""}]}