openapi: 3.1.0 info: title: Spoke Depots Plans API description: "This is the documentation of the Spoke Public API HTTP endpoints. The Spoke\nPublic API is a way for you to interact with Spoke products programmatically.\n\n# Introduction\n\nThe API has a set of HTTP methods to operate on Spoke resources for a specific\nteam.\n\nCurrently, Spoke offers no programming SDKs for interacting with the Public\nAPI, but you can implement your own interface by calling the methods documented\non this page.\n\n# Using the API\n\nThis section describes how the Spoke API should be used, if you wish to see\nexample implementations take a look at the [API Usage\nExamples](/docs/api-examples) page.\n\n## Address\n\nThe base API address for this version of the API to be used before every\nendpoint listed here is: `https://api.spoke.com/public/v0.2b`\n\nNotice the `https://` prefix, Spoke API will **not** accept plain HTTP\nrequests.\n\n## Authentication\n\nTo use Spoke Public API endpoints you will first need to generate an API key\nfor authenticating with our servers.\n\nTo do this you need to go to your Spoke Dispatch settings page > Integrations\n\\> API, and generate a new key there.\n\nOnce you have the API key you can use it in the `Authorization` header\neither using the Basic scheme, or as a Bearer token.\n\n### Basic Auth\n\n[Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) is the primary authentication scheme used\nby Spoke's API.\n\nBasic authentication typically uses a base64 encoded `username:password`\npair, but since we only require an API key we instead structure the payload as `[yourApiKey]:[empty]`. This\nvalue is then base64 encoded as usual.\n\nExample with `curl`:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans\" -u yourApiKey:\n```\n\nIf you did everything correctly you should see a list of your team's plans in response\nto this request.\n\nThe `-u` flag adds a header to the request in the following format:\n\n```http\nAuthorization: Basic eW91ckFwaUtleToK\n```\n\nNote that curl automatically base64 encoded the data. Other clients will do the same e.g. if using Postman you would\nconfigure the request's Authorization option instead of adding a header directly.\n\n### Bearer Token\n\nAlternatively you can pass the API key as a Bearer token without any special encoding.\ni.e. `Authorization: Bearer [yourApiKey]`.\n\nExample with `curl`:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans\" -H \"Authorization: Bearer yourApiKey\"\n```\n\n## On resource types\n\nEvery response from the Spoke Public API will be as JSON Objects, and every\nrequest that has a body also needs to be in that type, and the header\n`Content-type: application/json` needs to present, so the server knows that the\nbody you are sending is valid JSON. Spoke will reject requests without that\nheader, so be sure to use it.\n\n## On resource IDs\n\nEvery resource in the Spoke Public API has a unique ID. This ID is generated\nby Spoke and is unique for every resource per collection.\n\nEvery resource representation returned by the API will show the ID in the\nfollowing format:\n\n```json\n{\n \"id\": \"collectionName/resourceId\"\n}\n```\n\nAnd if the resource is on a sub-collection, it will be in the following format:\n\n```json\n{\n \"id\": \"collectionName/resourceId/subcollectionName/subResourceId\"\n}\n```\n\nFor example, a stop with ID `stop1` under a plan with ID `plan1` will have the\nfollowing representation on its serialized ID field:\n\n```json\n{\n \"id\": \"plans/plan1/stops/stop1\"\n}\n```\n\nThis means that if you wish to directly retrieve this stop by using a GET\nendpoint you can simply use this ID as follows:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/`serializedId`\" -u yourApiKey:\n```\n\nFor the example above this would be:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans/plan1/stops/stop1\" -u yourApiKey:\n```\n\n## On List endpoints\n\nWhen using list endpoints, you have the ability to combine various query options\nto locate the desired results. Some endpoints even offer specific filter options\nto aid in this search.\n\nAll the list endpoints employ pagination. This means that a single request might\nonly return a part of the entire set of resources you're aiming to retrieve. To\nmove through the subsequent pages, the Spoke API provides a `nextPageToken`\nfield in the response of every list endpoint query.\n\nIt's crucial to understand that when a `nextPageToken` is returned, it indicates\nthat more data is available. For every subsequent request, this token should be\nadded as the `pageToken` query parameter. And, importantly, **all the original\nquery parameters** used in the first request must also be included.\n\nHere's a step-by-step example to elucidate this:\n\n1. Suppose you initiate a request to list your plans:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans?filter.startsGte=2023-05-01\" -u yourApiKey:\n```\n\n2. The Spoke API might return a response like:\n\n```json\n{\n // other attributes\n \"nextPageToken\": \"I53Jr5Eu2qK9omh0iA8q\"\n}\n```\n\n3. To retrieve the next page of data, use the returned `nextPageToken` as the\n `pageToken` query parameter, and ensure all initial query parameters remain\n the same:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans?filter.startsGte=2023-05-01&pageToken=I53Jr5Eu2qK9omh0iA8q\" -u yourApiKey:\n```\n\n4. Repeat step 3 for all subsequent pages, updating the `pageToken` parameter\n with the latest `nextPageToken` value returned until `nextPageToken` is\n `null` in the response.\n\nSpoke also accepts limiting the maximum number of results per page by using\nthe `maxPageSize` query parameter, but notice that each individual endpoint has\na maximum value you can set this to.\n\n## On Update endpoints (HTTP PATCH verb)\n\nUpdate methods differ from the other methods in the API in the sense that\nmissing values in the JSON representation will **not** act upon the\nrepresentation of the resource.\n\nExplaining this by example: Suppose you have a Plan with the ID `plan1` in your\nplans' collection, and you wanted to merely update its title to `My API Plan`\nwithout changing other information, such as assigned drivers or the start date.\nTo do this you would issue the following request:\n\n```bash\ncurl -X PATCH http://localhost:5005/public/v0.2b/plans/plan1 -H 'Content-type: application/json' -d '{\"title\": \"My API Plan\"}' -u yourApiKey:\n```\n\nNotice how we don't pass any other information in the JSON, only the title. This\nensures that the `PATCH` request will only operate on the provided parameters\nand keep the other parameters as-is.\n\nIt is important to also notice that when updating an array the whole array will\nbe replaced, Spoke API does not support partial updates on arrays.\n\n## On Rate-Limiting\n\nAll the endpoints in the Spoke Public API are rate-limited, which means we\nwill reject requests that come in too fast.\n\nTo know if your request was rate-limited, check if the response has the HTTP\nstatus code 429.\n\nEach endpoint has a different rate limit, and Spoke can change this rate\nlimit at any moment.\n\nThe rate limits are as follows:\n\n- **Rate Limits for Write Endpoints**: All write endpoints have a limit of 5\n requests per second, which includes Creation (POST), Update (PATCH), and\n Deletion (DELETE) operations for all models.\n - An exception to this rule is the Driver Creation endpoint, which is limited to\n 1 request per second. Thus, we recommend using the Batch Import Drivers\n when adding multiple drivers.\n- **Rate Limits for Read Endpoints**: All read endpoints, including list\n endpoints, are limited to 10 requests per second.\n- **Rate Limits for Batch Import**:\n - The _Batch Import_ endpoints for Stops and Unassigned Stops models are\n limited to 100 requests per _10 minutes_ (with a maximum rate of 30 per _minute_).\n However, these endpoints can handle the import of up to 1,000 stops per minute.\n The Creation, Update, and Deletion endpoints for these models still maintain\n a rate limit of 5 requests per second.\n - The _Batch Import_ endpoint for Drivers is limited to 2 requests per\n _minute_. This allows for the import of up to 100 drivers per minute.\n- **Rate Limits for Optimization Endpoints**: The Plan _optimization_ and\n _re-optimization_ endpoints are limited to 100 requests per _10 minutes_\n (with a maximum rate of 30 per _minute_), due to the long running nature of these operations.\n\nSpoke API will occasionally support bursts of requests, but they cannot be\nsustained and will be rejected if they last too long.\n\nIf Spoke rejects your request because it exceeds the rate limit, you must\nwait before retrying it. We suggest you use an [exponential\nbackoff](https://en.wikipedia.org/wiki/Exponential_backoff) approach for this.\n\nWe also recommend, besides the exponential backoff algorithm, that you add a\nrandom delay to each attempt to prevent a [thundering herd\nproblem](https://en.wikipedia.org/wiki/Thundering_herd_problem).\n\nIf the client keeps retrying rate-limited requests while being rejected with a\n429 at a high rate, Spoke will keep rejecting the requests until you turn\ndown the request rate.\n\nSpoke will also limit requests if it keeps receiving them at a high frequency\nat or close to the requests limit for an extended period, so while we support\nan occasional burst of requests, if this is sustained for a long period, we\nwill rate-limit the client making them.\n\nWhile we feel these rate-limits will work for the vast majority of use cases we\nunderstand every team is different. So please reach out to us and describe your\nuse case if these limits are not enough for you, and we will evaluate\nincreasing them for your team.\n\n## On the models\n\nAfter this section you will find all the Spoke Public API endpoints available.\n\nEvery representation of resources that these endpoints create and return are\ndocumented in the [Models](/docs/category/models) page of the docs.\n" version: v0.2b servers: - url: https://api.spoke.com/public/v0.2b security: - BasicAuth: [] tags: - name: Plans description: 'Endpoints to operate on [Plans](/docs/models/plan) resources. ' paths: /plans: post: operationId: createPlan summary: Create a new plan tags: - Plans requestBody: content: application/json: schema: description: The request body for creating a plan. type: object properties: title: type: string minLength: 1 maxLength: 255 starts: description: The date the plan starts. Does not accept dates that are too far in the future or past. type: object properties: day: description: The day of the date. type: integer minimum: 1 maximum: 31 month: description: The month of the date. type: integer minimum: 1 maximum: 12 year: description: The year of the date. type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - day - month - year additionalProperties: false drivers: default: [] description: The drivers IDs of the plan, in the format `drivers/`, duplicates will be ignored maxItems: 50 type: array items: description: The driver id, in the format `drivers/` type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ depot: description: The depot id, in the format `depots/`. If not provided, the team's Main Depot will be used. anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' required: - title - starts additionalProperties: false required: true description: The request body for creating a plan. responses: '200': description: The created plan content: application/json: schema: $ref: '#/components/schemas/planSchema' description: The created plan '400': description: The request is invalid, or a driver is not active. content: application/json: schema: oneOf: - type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: Failed to validate the request - type: object properties: message: type: string enum: - Driver is not active code: type: string enum: - driver_not_active param: type: string description: The parameter that caused the error. required: - message - code description: The driver is not active title: Driver is not active description: The request is invalid, or a driver is not active. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The depot or driver could not be found. content: application/json: schema: oneOf: - type: object properties: message: type: string enum: - Depot not found required: - message description: The provided depot id does not exist title: Depot not found - type: object properties: message: anyOf: - type: string enum: - Driver not found - type: string required: - message description: The provided driver id does not exist title: Driver not found description: The depot or driver could not be found. '409': description: Depot not found content: application/json: schema: type: object properties: message: type: string enum: - Depot not found code: type: string enum: - depot_not_found required: - message - code description: Depot not found title: Depot not found '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model get: operationId: listPlans summary: List plans tags: - Plans parameters: - schema: type: string minLength: 1 maxLength: 255 in: query name: pageToken required: false description: The page token, if any. - schema: default: 10 type: number minimum: 1 maximum: 20 in: query name: maxPageSize required: false description: The max page size. - schema: type: object properties: title: description: Filter by title, exact match type: string minLength: 1 maxLength: 255 startsGte: description: Search for plans that start after this date, inclusive. The date must be in the format YYYY-MM-DD. type: string pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ startsLte: description: Search for plans that start before this date,inclusive. The date must be in the format YYYY-MM-DD. type: string pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ additionalProperties: false in: query name: filter required: false description: 'The filter to apply to the list of plans. The filter params are passed like this: `?filter[title]=foo` or like this: `?filter.title=foo`' responses: '200': description: Success content: application/json: schema: type: object properties: plans: type: array items: $ref: '#/components/schemas/planSchema' description: The plans list. nextPageToken: anyOf: - type: string - type: 'null' description: The next page token. required: - plans - nextPageToken definitions: planSchema: type: object properties: id: type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$ description: The unique identifier of the plan. title: type: string description: The title of the plan. starts: type: object properties: day: type: integer minimum: 1 maximum: 31 description: The day of the date. month: type: integer minimum: 1 maximum: 12 description: The month of the date. year: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The year of the date. required: - day - month - year additionalProperties: false description: A date. depot: anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' description: The depot ID of the plan, in the format depots/ distributed: type: boolean description: Whether the plan has been distributed. writable: type: boolean description: Whether the plan is writable using the normal Plan APIs. If this is false, you will need to use the [Live Plan APIs](/api/v0.2b#tag/Live-Plans) to edit the plan. Any plan created before 2023-04-01 is not writable. optimization: anyOf: - type: string enum: - creating - editing - preview - optimized - optimizing - type: 'null' description: The optimization state of the plan. drivers: type: array items: type: object properties: id: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ description: The driver id, in the format `drivers/` name: anyOf: - type: string - type: 'null' description: The name of the driver. email: anyOf: - type: string - type: 'null' description: The email of the driver. phone: anyOf: - type: string - type: 'null' description: The phone number of the driver. displayName: anyOf: - type: string - type: 'null' description: The display name of the driver. active: type: boolean description: Whether the driver membership is active or paused. Paused drivers will not be assigned to any routes. depots: type: array items: type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ description: Depots associated with the driver. routeOverrides: type: object properties: startTime: anyOf: - type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. - type: 'null' description: Driver's start time. endTime: anyOf: - type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. - type: 'null' description: Driver's end time. startAddress: anyOf: - type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. - type: 'null' description: Driver's start location. endAddress: anyOf: - type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. - type: 'null' description: Driver's end location. maxStops: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Maximum number of Stops the Driver can take in a route. drivingSpeed: type: string enum: - slower - average - faster description: The relative driving speed of the driver compared to others. deliverySpeed: type: string enum: - slower - average - faster description: The relative delivery speed of the driver compared to others. vehicleType: anyOf: - type: string enum: - bike - scooter - car - small_truck - truck - electric_cargo_bike - type: 'null' description: The vehicle type the driver will be using for deliveries. required: - startTime - endTime - startAddress - endAddress - maxStops - drivingSpeed - deliverySpeed - vehicleType description: Settings to override default route settings. required: - id - name - email - phone - displayName - active - depots - routeOverrides additionalProperties: false description: A driver. description: The driver IDs of the plan, in the format drivers/. routes: type: array items: type: string pattern: ^routes\/[a-zA-Z0-9---_]{1,50}$ description: The route IDs of the plan, in the format routes/. required: - id - title - starts - depot - distributed - writable - optimization - drivers - routes additionalProperties: false description: A plan. description: Success '400': description: Query parameters are invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: Query parameters are invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model /plans/{planId}: patch: operationId: updatePlan summary: Update an existing plan tags: - Plans description: Update an existing plan. If the plan `writable` property is false, prefer using the [Live Plans API](#tag/Live-Plans). requestBody: content: application/json: schema: description: 'The request body for updating a plan. All the values present in the request will update the plan value, if you wish to update only certain fields, only set them and do not set the others. Any fields not set will not be updated. **Important:** Notice that the `drivers` Array will be completely replaced. If a single driver is provided in the request, the plan will have all other previous drivers discarded.' type: object properties: title: type: string minLength: 1 maxLength: 255 starts: description: The date the plan starts. Does not accept dates that are too far in the future or past. type: object properties: day: description: The day of the date. type: integer minimum: 1 maximum: 31 month: description: The month of the date. type: integer minimum: 1 maximum: 12 year: description: The year of the date. type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - day - month - year additionalProperties: false drivers: description: The drivers IDs of the plan, in the format `drivers/`, duplicates will be ignored maxItems: 50 type: array items: description: The driver id, in the format `drivers/` type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ depot: description: The depot id, in the format `depots/`. If not provided, the team's Main Depot will be used. anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' additionalProperties: false description: 'The request body for updating a plan. All the values present in the request will update the plan value, if you wish to update only certain fields, only set them and do not set the others. Any fields not set will not be updated. **Important:** Notice that the `drivers` Array will be completely replaced. If a single driver is provided in the request, the plan will have all other previous drivers discarded.' parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '200': description: The updated plan content: application/json: schema: $ref: '#/components/schemas/planSchema' description: The updated plan '400': description: The request is invalid, or a driver is not active. content: application/json: schema: oneOf: - type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: Failed to validate the request - type: object properties: message: type: string enum: - Driver is not active code: type: string enum: - driver_not_active param: type: string description: The parameter that caused the error. required: - message - code description: The driver is not active title: Driver is not active description: The request is invalid, or a driver is not active. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The plan, depot, or driver could not be found. content: application/json: schema: oneOf: - type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found - type: object properties: message: type: string enum: - Depot not found required: - message description: The provided depot id does not exist title: Depot not found - type: object properties: message: anyOf: - type: string enum: - Driver not found - type: string required: - message description: The provided driver id does not exist title: Driver not found description: The plan, depot, or driver could not be found. '409': description: The plan is not writable. content: application/json: schema: type: object properties: message: type: string enum: - Plan is not writable code: type: string enum: - plan_not_writable required: - message - code description: The plan is not writable. title: Plan is not writable default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model get: operationId: getPlan summary: Retrieve a plan tags: - Plans description: Retrieve a plan parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '200': description: The requested plan content: application/json: schema: $ref: '#/components/schemas/planSchema' description: The requested plan '400': description: ID format is invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: ID format is invalid title: The request is invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The provided plan id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model delete: operationId: deletePlan summary: Delete a plan tags: - Plans description: Delete a plan and related routes. This action cannot be undone and will delete all the releated routes as well, even if the plan is not in a writable state. As this action is not atomic, it is possible that only partial deletion occurs if the endpoint errors out with a 500. In that case it is recommended to retry the request. parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '204': description: Plan deleted successfully '400': description: ID format is invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: ID format is invalid title: The request is invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The provided plan id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model /plans/{planId}:optimize: post: operationId: optimizePlan summary: Optimize a plan tags: - Plans description: Optimize a plan. Returns the created operation, which can be polled for the result. Use the returned `id` with the [operations](#tag/Operations) endpoints to poll for the result. parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '200': description: The created plan_optimization operation. content: application/json: schema: $ref: '#/components/schemas/operationSchema' description: The created plan_optimization operation. '400': description: ID format is invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: ID format is invalid title: The request is invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The provided plan id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found '409': description: The plan is not writable, an optimization is already in progress, there are no drivers, or there is a problem with the depot. content: application/json: schema: oneOf: - type: object properties: message: type: string enum: - Plan already optimized code: type: string enum: - plan_already_optimized required: - message - code title: Plan already optimized - type: object properties: message: type: string enum: - Plan optimization in progress code: type: string enum: - plan_optimization_in_progress required: - message - code description: The plan's optimization is in progress. title: Plan optimization in progress - type: object properties: message: type: string enum: - Plan has no drivers. Either the plan's depot has no drivers, if the optimization is for minimizing drivers, or the plan has no assigned drivers. code: type: string enum: - no_drivers_available required: - message - code description: The plan has no available drivers. title: Plan has no drivers - type: object properties: message: type: string enum: - Please set an end time or max stops per driver for the plan's depot when optimizing to minimize drivers. code: type: string enum: - no_end_time_and_max_stops_per_driver required: - message - code description: The plan's depot has no end time and max stops per driver. title: Plan's depot has no end time and max stops per driver - type: object properties: message: type: string enum: - Depot not found code: type: string enum: - depot_not_found required: - message - code description: Depot not found title: Depot not found x-response-description: Depot not found - type: object properties: message: type: string enum: - Please set a start location for the plan's depot. code: type: string enum: - depot_missing_start_address required: - message - code description: Depot not found title: Plan's depot missing start address description: The plan is not writable, an optimization is already in progress, there are no drivers, or there is a problem with the depot. '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model /plans/{planId}:distribute: post: operationId: distributePlan summary: Distribute a plan tags: - Plans description: Distribute a plan to its drivers. This will send then their routes. parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '200': description: The distributed plan content: application/json: schema: $ref: '#/components/schemas/planSchema' description: The distributed plan '400': description: ID format is invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: ID format is invalid title: The request is invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The provided plan id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found '409': description: The plan is not yet optimized, is optimizing, was already distributed or was modified whilst processing request. content: application/json: schema: oneOf: - type: object properties: message: type: string enum: - Plan already distributed code: type: string enum: - plan_already_distributed required: - message - code description: The plan is already distributed. title: Plan already distributed - type: object properties: message: type: string enum: - Plan not optimized code: type: string enum: - plan_not_optimized required: - message - code description: The plan is not optimized. title: Plan not optimized - type: object properties: message: type: string enum: - Plan optimization in progress code: type: string enum: - plan_optimization_in_progress required: - message - code description: The plan's optimization is in progress. title: Plan optimization in progress - type: object properties: message: type: string enum: - Plan was modified by a concurrent request. Please retry your request. code: type: string enum: - plan_concurrent_modification required: - message - code description: Plan modified whilst processing request title: Plan modified whilst processing request description: The plan is not yet optimized, is optimizing, was already distributed or was modified whilst processing request. '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model /plans/{planId}/stops: get: operationId: listPlanStops summary: List plan stops tags: - Plans parameters: - schema: type: string minLength: 1 maxLength: 255 in: query name: pageToken required: false description: The page token, if any. - schema: default: 10 type: number minimum: 1 maximum: 10 in: query name: maxPageSize required: false description: The max page size. - schema: type: object properties: externalId: description: Filter by the `recipient.externalId` field, exact match type: string minLength: 1 maxLength: 255 additionalProperties: false in: query name: filter required: false description: 'The filter to apply to the list of stops. The filter params are passed like this: `?filter[externalId]=foo` or like this: `?filter.externalId=foo`' - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: planId required: true description: The plan id responses: '200': description: Success content: application/json: schema: type: object properties: stops: type: array items: $ref: '#/components/schemas/stopSchema' description: The stops list. nextPageToken: anyOf: - type: string - type: 'null' description: The next page token. required: - stops - nextPageToken definitions: stopSchema: type: object properties: id: type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}\/stops\/[a-zA-Z0-9---_]{1,50}$ description: The id of the stop, in the format `plans//stops/`. address: type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. barcodes: type: array items: type: string description: List of Barcode IDs associated with the stop. allowedDrivers: type: array items: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ description: The driver IDs that can be assigned to this stop estimatedTravelDuration: anyOf: - type: number - type: 'null' description: Estimated time that the driver will take to arrive at this stop from the previous stop in seconds. estimatedTravelDistance: anyOf: - type: number - type: 'null' description: The distance in meters between the previous stop and this stop. notes: anyOf: - type: string - type: 'null' description: Notes for the stop. packageCount: anyOf: - type: number - type: 'null' description: The number of packages. weight: anyOf: - type: object properties: amount: type: number minimum: 0 description: The weight amount for this stop. unit: type: string enum: - kilogram - pound - metric-ton description: The weight unit in which the amount is specified (defined at team's capacity unit). required: - amount - unit additionalProperties: false description: Weight information for the stop. - type: 'null' type: type: string enum: - start - stop - end description: The type of the stop. `start` is the first stop of the route, `stop` is a stop in the middle of the route, and `end` is the last stop of the route. packageLabel: anyOf: - type: string - type: 'null' description: The label of the package. stopPosition: anyOf: - type: number - type: 'null' description: The position of the stop in the route. trackingLink: anyOf: - type: string - type: 'null' description: The recipient tracking link. webAppLink: type: string description: The web app link. orderInfo: type: object properties: products: type: array items: type: string description: The products of the stop. invoiceNumber: anyOf: - type: string - type: 'null' description: Invoice number associated with the order. sellerName: anyOf: - type: string - type: 'null' description: Name of the seller where the order is from. sellerOrderId: anyOf: - type: string - type: 'null' description: Id of the seller where the order is from. sellerWebsite: anyOf: - type: string - type: 'null' description: Website of the seller where the order is from. required: - products - invoiceNumber - sellerName - sellerOrderId - sellerWebsite additionalProperties: false description: The order information of the stop. placeInVehicle: anyOf: - type: object properties: x: anyOf: - type: string enum: - left - right - type: 'null' description: The x position of the package. y: anyOf: - type: string enum: - front - back - middle - type: 'null' description: The y position of the package. z: anyOf: - type: string enum: - floor - shelf - type: 'null' description: The z position of the package. required: - x - y - z additionalProperties: false description: The position of the package in the vehicle. - type: 'null' recipient: type: object properties: name: anyOf: - type: string - type: 'null' description: The name of the recipient. email: anyOf: - type: string - type: 'null' description: The email of the recipient. phone: anyOf: - type: string - type: 'null' description: The phone of the recipient. externalId: anyOf: - type: string - type: 'null' description: The external id of the recipient. required: - name - email - phone - externalId additionalProperties: false description: The recipient of the stop. activity: default: delivery type: string enum: - delivery - pickup deliveryInfo: anyOf: - type: object properties: attempted: type: boolean description: Whether the stop was attempted. attemptedAt: anyOf: - type: number - type: 'null' description: When the stop was attempted in seconds since epoch. timeAtStopInfo: oneOf: - type: object properties: status: type: string enum: - available value: type: object properties: arrivedAt: anyOf: - type: number - type: 'null' description: When the driver arrived at the stop in seconds since epoch. departedAt: anyOf: - type: number - type: 'null' description: When the driver departed from the stop in seconds since epoch. isEstimated: anyOf: - type: boolean - type: 'null' description: Whether the time at stop was estimated rather than directly measured. required: - arrivedAt - departedAt - isEstimated additionalProperties: false description: Grouped time-at-stop data. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending pendingReason: type: string enum: - not_yet_arrived required: - status additionalProperties: false attemptedLocation: anyOf: - type: object properties: latitude: type: number description: The latitude of the location. longitude: type: number description: The longitude of the location. required: - latitude - longitude additionalProperties: false description: A location. - type: 'null' description: Where the stop was attempted. driverProvidedInternalNotes: anyOf: - type: string - type: 'null' description: Internal notes provided by the driver. driverProvidedRecipientNotes: anyOf: - type: string - type: 'null' description: Recipient notes provided by the driver. photoUrls: type: array items: type: string description: URLs of proof of delivery photos. recipientProvidedNotes: anyOf: - type: string - type: 'null' description: Notes from recipient signatureUrl: anyOf: - type: string - type: 'null' description: URL of the signature. signeeName: anyOf: - type: string - type: 'null' description: Name of the signee. succeeded: type: boolean description: Whether the stop was succeeded. state: type: string enum: - delivered_to_recipient - delivered_to_third_party - delivered_to_mailbox - delivered_to_safe_place - delivered_to_pickup_point - delivered_other - picked_up_from_customer - picked_up_unmanned - picked_up_from_locker - picked_up_other - failed_not_home - failed_cant_find_address - failed_no_parking - failed_no_time - failed_package_not_available - failed_other - failed_missing_required_proof - failed_payment_not_received - unattempted description: The state of the delivery. required: - attempted - attemptedAt - timeAtStopInfo - attemptedLocation - driverProvidedInternalNotes - driverProvidedRecipientNotes - photoUrls - recipientProvidedNotes - signatureUrl - signeeName - succeeded - state additionalProperties: false description: The delivery information of the stop. - type: 'null' paymentOnDelivery: anyOf: - type: object properties: amount: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' description: The amount *in minor units* (e.g. cents) to be collected upon delivery. currency: type: string description: The payment's currency in ISO 4217 standard. required: - amount - currency additionalProperties: false description: The payment due upon delivery also known as "Cash on Delivery". - type: 'null' proofOfAttemptRequirements: type: object properties: enabled: anyOf: - type: boolean - type: 'null' description: Whether the proof of attempt is enabled.This only works if the team subscription has access to proof of delivery required: - enabled additionalProperties: false description: The proof of attempt requirements of the stop. plan: type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$ description: The id of the plan, in the format `plans/`. route: anyOf: - type: object properties: id: type: string pattern: ^routes\/[a-zA-Z0-9---_]{1,50}$ description: The id of the route, in the format `routes/`. title: type: string description: The title of the route. stopCount: type: number description: The number of stops in the route. driver: anyOf: - type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' description: The id of the driver. state: anyOf: - type: object properties: completed: type: boolean description: Whether the route is completed. completedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was completed at. distributed: type: boolean description: Whether the route is distributed. distributedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was distributed at. notifiedRecipients: type: boolean description: Whether the recipients were notified. notifiedRecipientsAt: anyOf: - type: number - type: 'null' description: The timestamp the recipients were notified at. started: type: boolean description: Whether the route is started. startedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was started at. required: - completed - completedAt - distributed - distributedAt - notifiedRecipients - notifiedRecipientsAt - started - startedAt additionalProperties: false description: The state of a route. - type: 'null' description: The state of the route. plan: anyOf: - type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' description: The id of the related plan. required: - id - title - stopCount - driver - state - plan additionalProperties: false description: A route. - type: 'null' description: The route of the stop, if any. eta: oneOf: - type: object properties: status: type: string enum: - available value: type: object properties: estimatedArrivalAt: type: number description: The estimated time in seconds since epoch. estimatedLatestArrivalAt: type: number description: The latest estimated time in seconds since epoch. estimatedEarliestArrivalAt: type: number description: The earliest estimated time in seconds since epoch. required: - estimatedArrivalAt - estimatedLatestArrivalAt - estimatedEarliestArrivalAt additionalProperties: false description: The estimated time of arrival data of the stop. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending pendingReason: type: string enum: - not_optimized required: - status additionalProperties: false timing: type: object properties: estimatedAttemptDuration: anyOf: - type: number - type: 'null' description: Time that the driver estimates to spend on the stop to do his job (deliver a parcel, visit a client, etc) in seconds. earliestAttemptTime: anyOf: - type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. - type: 'null' description: The earliest time that the driver should arrive at the stop latestAttemptTime: anyOf: - type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. - type: 'null' description: The latest time that the driver should arrive at the stop. required: - estimatedAttemptDuration - earliestAttemptTime - latestAttemptTime additionalProperties: false description: The timing data of the stop. optimizationOrder: default: default type: string enum: - first - last - default customProperties: anyOf: - type: object propertyNames: type: string additionalProperties: anyOf: - type: string - type: 'null' - type: 'null' description: Custom properties of the stop, can be used to store additional information. clientId: anyOf: - type: string - type: 'null' description: The associated Client ID of the Spoke Connect serviceInfo: oneOf: - type: object properties: status: type: string enum: - available value: anyOf: - type: object properties: identifier: type: string description: The service offering identifier, as configured in Spoke Dispatch, captured at assignment time. Not currently discoverable through the public API. name: type: string description: The human-readable service name. slaStartsAt: type: number description: The SLA start time in seconds since epoch. slaDueDate: type: object properties: day: type: integer minimum: 1 maximum: 31 description: The day of the date. month: type: integer minimum: 1 maximum: 12 description: The month of the date. year: type: integer minimum: 2000 maximum: 2100 description: The year of the date. required: - day - month - year additionalProperties: false description: The computed SLA due date in the team's timezone. slaDueTime: anyOf: - type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. - type: 'null' description: SLA due time-of-day in the team's timezone, null for day-level SLA. deliveryHorizon: type: object properties: unit: anyOf: - type: string enum: - days - hours - type: string description: 'The time unit of the delivery horizon. Known: `days`, `hours`.' value: type: number description: The number of time units in the delivery horizon. required: - unit - value additionalProperties: false description: The delivery horizon for this service. price: type: object properties: value: type: number description: Price in minor currency units (e.g. cents). currency: anyOf: - type: string enum: - AED - ARS - AUD - BRL - CAD - CHF - CLP - CNY - COP - DKK - EGP - EUR - GBP - HKD - HUF - ILS - INR - JPY - KRW - MYR - MXN - NOK - NZD - PEN - RON - RUB - SAR - SEK - SGD - TRY - USD - UYU - ZAR - type: string description: 3-letter ISO 4217 currency code. required: - value - currency additionalProperties: false description: Price for this service at assignment time. hasPaymentOnDelivery: type: boolean description: Whether cash on delivery is enabled via the service. definedAt: type: number description: When the service was assigned in seconds since epoch. required: - identifier - name - slaStartsAt - slaDueDate - slaDueTime - deliveryHorizon - price - hasPaymentOnDelivery - definedAt additionalProperties: false description: Service offering data when a service is assigned to the stop. - type: object properties: identifier: type: 'null' description: Null indicates no service offering is linked. slaStartsAt: type: number description: The SLA start time in seconds since epoch. required: - identifier - slaStartsAt additionalProperties: false description: Service data when only an SLA start time is set. description: Service offering data for this stop. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - empty required: - status additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false description: Service offering data for this stop. required: - id - address - barcodes - allowedDrivers - estimatedTravelDuration - estimatedTravelDistance - notes - packageCount - weight - type - packageLabel - stopPosition - trackingLink - webAppLink - orderInfo - placeInVehicle - recipient - deliveryInfo - paymentOnDelivery - proofOfAttemptRequirements - plan - route - eta - timing - customProperties - clientId - serviceInfo additionalProperties: false description: A stop of a plan, can be related to a route. description: Success '400': description: Query parameters are invalid content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: Query parameters are invalid '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The error message. url: type: string description: The URL with more information about the error. required: - message description: Unauthorized '403': description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. content: application/json: schema: type: object properties: message: type: string enum: - Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. code: type: string enum: - plan_inaccessible url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Plan is no longer accessible due to data access restrictions. Upgrade to a plan that supports a longer delivery history period to access it. '404': description: The provided plan id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Plan not found required: - message description: The provided plan id does not exist title: Plan not found '500': description: An internal server error occurred content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: An internal server error occurred default: description: The default error model content: application/json: schema: type: object properties: message: type: string description: The error message. code: type: string description: The error code. param: type: string description: The parameter that caused the error. url: type: string description: The URL with more information about the error. required: - message description: The default error model components: schemas: operationSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/operationIdSchema' description: The id of the operation, in the format `operations/`. type: type: string enum: - plan_optimization done: type: boolean description: Whether the operation is done. metadata: type: object properties: canceled: type: boolean description: Whether the operation was canceled. startedAt: type: number description: The time the operation started at, in seconds since epoch. finishedAt: anyOf: - type: number - type: 'null' description: The time the operation finished at, in seconds since epoch. startedBy: anyOf: - type: string enum: - dispatcher - type: string enum: - api - type: string description: The entity that started the operation. targetPlanId: allOf: - $ref: '#/components/schemas/planIdSchema' description: The id of the plan, in the format `plans/`. required: - canceled - startedAt - finishedAt - startedBy - targetPlanId description: Metadata related to a plan optimization operation. result: anyOf: - anyOf: - type: object properties: numOptimizedStops: type: number description: The number of stops that were considered for optimization. skippedStops: type: array items: type: object properties: id: allOf: - $ref: '#/components/schemas/stopIdSchema' description: The id of the stop, in the format `plans//stops/`. reason: anyOf: - type: string enum: - impossible_time_window - type: string enum: - impossible_navigation - type: string enum: - impossible_number_of_stops - type: string enum: - impossible_order_of_stops - type: string description: The reason the stop was skipped. required: - id - reason description: The stops that were skipped, if any. required: - numOptimizedStops - skippedStops - type: object properties: code: type: string description: A code that identifies the error message: type: string description: A human-readable message that describes the error. This message is not intended to be parsed by machines. required: - code - message - type: 'null' description: The result of the plan optimization operation, or an error. required: - id - type - done - metadata - result routeSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/routeIdSchema' description: The id of the route, in the format `routes/`. title: type: string description: The title of the route. stopCount: type: number description: The number of stops in the route. driver: anyOf: - $ref: '#/components/schemas/driverIdSchema' - type: 'null' description: The id of the driver. state: anyOf: - type: object properties: completed: type: boolean description: Whether the route is completed. completedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was completed at. distributed: type: boolean description: Whether the route is distributed. distributedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was distributed at. notifiedRecipients: type: boolean description: Whether the recipients were notified. notifiedRecipientsAt: anyOf: - type: number - type: 'null' description: The timestamp the recipients were notified at. started: type: boolean description: Whether the route is started. startedAt: anyOf: - type: number - type: 'null' description: The timestamp the route was started at. required: - completed - completedAt - distributed - distributedAt - notifiedRecipients - notifiedRecipientsAt - started - startedAt additionalProperties: false description: The state of a route. - type: 'null' description: The state of the route. plan: anyOf: - $ref: '#/components/schemas/planIdSchema' - type: 'null' description: The id of the related plan. required: - id - title - stopCount - driver - state - plan additionalProperties: false description: A route. stopIdSchema: type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}\/stops\/[a-zA-Z0-9---_]{1,50}$ operationIdSchema: type: string pattern: ^operations\/[a-zA-Z0-9---_]{1,50}$ depotIdSchema: type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ routeIdSchema: type: string pattern: ^routes\/[a-zA-Z0-9---_]{1,50}$ stopSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/stopIdSchema' description: The id of the stop, in the format `plans//stops/`. address: type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. barcodes: type: array items: type: string description: List of Barcode IDs associated with the stop. allowedDrivers: type: array items: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ description: The driver IDs that can be assigned to this stop estimatedTravelDuration: anyOf: - type: number - type: 'null' description: Estimated time that the driver will take to arrive at this stop from the previous stop in seconds. estimatedTravelDistance: anyOf: - type: number - type: 'null' description: The distance in meters between the previous stop and this stop. notes: anyOf: - type: string - type: 'null' description: Notes for the stop. packageCount: anyOf: - type: number - type: 'null' description: The number of packages. weight: anyOf: - type: object properties: amount: type: number minimum: 0 description: The weight amount for this stop. unit: type: string enum: - kilogram - pound - metric-ton description: The weight unit in which the amount is specified (defined at team's capacity unit). required: - amount - unit additionalProperties: false description: Weight information for the stop. - type: 'null' type: type: string enum: - start - stop - end description: The type of the stop. `start` is the first stop of the route, `stop` is a stop in the middle of the route, and `end` is the last stop of the route. packageLabel: anyOf: - type: string - type: 'null' description: The label of the package. stopPosition: anyOf: - type: number - type: 'null' description: The position of the stop in the route. trackingLink: anyOf: - type: string - type: 'null' description: The recipient tracking link. webAppLink: type: string description: The web app link. orderInfo: type: object properties: products: type: array items: type: string description: The products of the stop. invoiceNumber: anyOf: - type: string - type: 'null' description: Invoice number associated with the order. sellerName: anyOf: - type: string - type: 'null' description: Name of the seller where the order is from. sellerOrderId: anyOf: - type: string - type: 'null' description: Id of the seller where the order is from. sellerWebsite: anyOf: - type: string - type: 'null' description: Website of the seller where the order is from. required: - products - invoiceNumber - sellerName - sellerOrderId - sellerWebsite additionalProperties: false description: The order information of the stop. placeInVehicle: anyOf: - type: object properties: x: anyOf: - type: string enum: - left - right - type: 'null' description: The x position of the package. y: anyOf: - type: string enum: - front - back - middle - type: 'null' description: The y position of the package. z: anyOf: - type: string enum: - floor - shelf - type: 'null' description: The z position of the package. required: - x - y - z additionalProperties: false description: The position of the package in the vehicle. - type: 'null' recipient: type: object properties: name: anyOf: - type: string - type: 'null' description: The name of the recipient. email: anyOf: - type: string - type: 'null' description: The email of the recipient. phone: anyOf: - type: string - type: 'null' description: The phone of the recipient. externalId: anyOf: - type: string - type: 'null' description: The external id of the recipient. required: - name - email - phone - externalId additionalProperties: false description: The recipient of the stop. activity: default: delivery type: string enum: - delivery - pickup deliveryInfo: anyOf: - type: object properties: attempted: type: boolean description: Whether the stop was attempted. attemptedAt: anyOf: - type: number - type: 'null' description: When the stop was attempted in seconds since epoch. timeAtStopInfo: oneOf: - type: object properties: status: type: string enum: - available value: type: object properties: arrivedAt: anyOf: - type: number - type: 'null' description: When the driver arrived at the stop in seconds since epoch. departedAt: anyOf: - type: number - type: 'null' description: When the driver departed from the stop in seconds since epoch. isEstimated: anyOf: - type: boolean - type: 'null' description: Whether the time at stop was estimated rather than directly measured. required: - arrivedAt - departedAt - isEstimated additionalProperties: false description: Grouped time-at-stop data. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending pendingReason: type: string enum: - not_yet_arrived required: - status additionalProperties: false attemptedLocation: anyOf: - type: object properties: latitude: type: number description: The latitude of the location. longitude: type: number description: The longitude of the location. required: - latitude - longitude additionalProperties: false description: A location. - type: 'null' description: Where the stop was attempted. driverProvidedInternalNotes: anyOf: - type: string - type: 'null' description: Internal notes provided by the driver. driverProvidedRecipientNotes: anyOf: - type: string - type: 'null' description: Recipient notes provided by the driver. photoUrls: type: array items: type: string description: URLs of proof of delivery photos. recipientProvidedNotes: anyOf: - type: string - type: 'null' description: Notes from recipient signatureUrl: anyOf: - type: string - type: 'null' description: URL of the signature. signeeName: anyOf: - type: string - type: 'null' description: Name of the signee. succeeded: type: boolean description: Whether the stop was succeeded. state: type: string enum: - delivered_to_recipient - delivered_to_third_party - delivered_to_mailbox - delivered_to_safe_place - delivered_to_pickup_point - delivered_other - picked_up_from_customer - picked_up_unmanned - picked_up_from_locker - picked_up_other - failed_not_home - failed_cant_find_address - failed_no_parking - failed_no_time - failed_package_not_available - failed_other - failed_missing_required_proof - failed_payment_not_received - unattempted description: The state of the delivery. required: - attempted - attemptedAt - timeAtStopInfo - attemptedLocation - driverProvidedInternalNotes - driverProvidedRecipientNotes - photoUrls - recipientProvidedNotes - signatureUrl - signeeName - succeeded - state additionalProperties: false description: The delivery information of the stop. - type: 'null' paymentOnDelivery: anyOf: - type: object properties: amount: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' description: The amount *in minor units* (e.g. cents) to be collected upon delivery. currency: type: string description: The payment's currency in ISO 4217 standard. required: - amount - currency additionalProperties: false description: The payment due upon delivery also known as "Cash on Delivery". - type: 'null' proofOfAttemptRequirements: type: object properties: enabled: anyOf: - type: boolean - type: 'null' description: Whether the proof of attempt is enabled.This only works if the team subscription has access to proof of delivery required: - enabled additionalProperties: false description: The proof of attempt requirements of the stop. plan: allOf: - $ref: '#/components/schemas/planIdSchema' description: The id of the plan, in the format `plans/`. route: anyOf: - $ref: '#/components/schemas/routeSchema' - type: 'null' description: The route of the stop, if any. eta: oneOf: - type: object properties: status: type: string enum: - available value: type: object properties: estimatedArrivalAt: type: number description: The estimated time in seconds since epoch. estimatedLatestArrivalAt: type: number description: The latest estimated time in seconds since epoch. estimatedEarliestArrivalAt: type: number description: The earliest estimated time in seconds since epoch. required: - estimatedArrivalAt - estimatedLatestArrivalAt - estimatedEarliestArrivalAt additionalProperties: false description: The estimated time of arrival data of the stop. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending pendingReason: type: string enum: - not_optimized required: - status additionalProperties: false timing: type: object properties: estimatedAttemptDuration: anyOf: - type: number - type: 'null' description: Time that the driver estimates to spend on the stop to do his job (deliver a parcel, visit a client, etc) in seconds. earliestAttemptTime: anyOf: - $ref: '#/components/schemas/timeOfDaySchema' - type: 'null' description: The earliest time that the driver should arrive at the stop latestAttemptTime: anyOf: - $ref: '#/components/schemas/timeOfDaySchema' - type: 'null' description: The latest time that the driver should arrive at the stop. required: - estimatedAttemptDuration - earliestAttemptTime - latestAttemptTime additionalProperties: false description: The timing data of the stop. optimizationOrder: default: default type: string enum: - first - last - default customProperties: anyOf: - type: object propertyNames: type: string additionalProperties: anyOf: - type: string - type: 'null' - type: 'null' description: Custom properties of the stop, can be used to store additional information. clientId: anyOf: - type: string - type: 'null' description: The associated Client ID of the Spoke Connect serviceInfo: oneOf: - type: object properties: status: type: string enum: - available value: anyOf: - type: object properties: identifier: type: string description: The service offering identifier, as configured in Spoke Dispatch, captured at assignment time. Not currently discoverable through the public API. name: type: string description: The human-readable service name. slaStartsAt: type: number description: The SLA start time in seconds since epoch. slaDueDate: type: object properties: day: type: integer minimum: 1 maximum: 31 description: The day of the date. month: type: integer minimum: 1 maximum: 12 description: The month of the date. year: type: integer minimum: 2000 maximum: 2100 description: The year of the date. required: - day - month - year additionalProperties: false description: The computed SLA due date in the team's timezone. slaDueTime: anyOf: - $ref: '#/components/schemas/timeOfDaySchema' - type: 'null' description: SLA due time-of-day in the team's timezone, null for day-level SLA. deliveryHorizon: type: object properties: unit: anyOf: - type: string enum: - days - hours - type: string description: 'The time unit of the delivery horizon. Known: `days`, `hours`.' value: type: number description: The number of time units in the delivery horizon. required: - unit - value additionalProperties: false description: The delivery horizon for this service. price: type: object properties: value: type: number description: Price in minor currency units (e.g. cents). currency: anyOf: - type: string enum: - AED - ARS - AUD - BRL - CAD - CHF - CLP - CNY - COP - DKK - EGP - EUR - GBP - HKD - HUF - ILS - INR - JPY - KRW - MYR - MXN - NOK - NZD - PEN - RON - RUB - SAR - SEK - SGD - TRY - USD - UYU - ZAR - type: string description: 3-letter ISO 4217 currency code. required: - value - currency additionalProperties: false description: Price for this service at assignment time. hasPaymentOnDelivery: type: boolean description: Whether cash on delivery is enabled via the service. definedAt: type: number description: When the service was assigned in seconds since epoch. required: - identifier - name - slaStartsAt - slaDueDate - slaDueTime - deliveryHorizon - price - hasPaymentOnDelivery - definedAt additionalProperties: false description: Service offering data when a service is assigned to the stop. - type: object properties: identifier: type: 'null' description: Null indicates no service offering is linked. slaStartsAt: type: number description: The SLA start time in seconds since epoch. required: - identifier - slaStartsAt additionalProperties: false description: Service data when only an SLA start time is set. description: Service offering data for this stop. required: - status - value additionalProperties: false - type: object properties: status: type: string enum: - empty required: - status additionalProperties: false - type: object properties: status: type: string enum: - restricted requiredFeature: type: string upgradeUrl: type: string restrictionCode: type: string enum: - subscription_not_supported required: - status additionalProperties: false description: Service offering data for this stop. required: - id - address - barcodes - allowedDrivers - estimatedTravelDuration - estimatedTravelDistance - notes - packageCount - weight - type - packageLabel - stopPosition - trackingLink - webAppLink - orderInfo - placeInVehicle - recipient - deliveryInfo - paymentOnDelivery - proofOfAttemptRequirements - plan - route - eta - timing - customProperties - clientId - serviceInfo additionalProperties: false description: A stop of a plan, can be related to a route. timeOfDaySchema: type: object properties: hour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hour of the day minute: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minute of the hour required: - hour - minute additionalProperties: false description: Time of day in hours and minutes. Uses a 24 hour clock. driverSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/driverIdSchema' description: The driver id, in the format `drivers/` name: anyOf: - type: string - type: 'null' description: The name of the driver. email: anyOf: - type: string - type: 'null' description: The email of the driver. phone: anyOf: - type: string - type: 'null' description: The phone number of the driver. displayName: anyOf: - type: string - type: 'null' description: The display name of the driver. active: type: boolean description: Whether the driver membership is active or paused. Paused drivers will not be assigned to any routes. depots: type: array items: $ref: '#/components/schemas/depotIdSchema' description: Depots associated with the driver. routeOverrides: type: object properties: startTime: anyOf: - $ref: '#/components/schemas/timeOfDaySchema' - type: 'null' description: Driver's start time. endTime: anyOf: - $ref: '#/components/schemas/timeOfDaySchema' - type: 'null' description: Driver's end time. startAddress: anyOf: - type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. - type: 'null' description: Driver's start location. endAddress: anyOf: - type: object properties: address: type: string description: The address of the stop. addressLineOne: type: string description: The first line of the address. addressLineTwo: type: string description: The second line of the address. latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' description: The latitude of the address in decimal degrees. longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' description: The longitude of the address in decimal degrees. placeId: anyOf: - type: string - type: 'null' description: The identifier of the place corresponding to this stop on Google Places placeTypes: type: array items: type: string description: Array of strings that is provided by the Google AutoCompleteAPI required: - address - addressLineOne - addressLineTwo - latitude - longitude - placeId - placeTypes additionalProperties: false description: The address of the stop. - type: 'null' description: Driver's end location. maxStops: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Maximum number of Stops the Driver can take in a route. drivingSpeed: type: string enum: - slower - average - faster description: The relative driving speed of the driver compared to others. deliverySpeed: type: string enum: - slower - average - faster description: The relative delivery speed of the driver compared to others. vehicleType: anyOf: - type: string enum: - bike - scooter - car - small_truck - truck - electric_cargo_bike - type: 'null' description: The vehicle type the driver will be using for deliveries. required: - startTime - endTime - startAddress - endAddress - maxStops - drivingSpeed - deliverySpeed - vehicleType description: Settings to override default route settings. required: - id - name - email - phone - displayName - active - depots - routeOverrides additionalProperties: false description: A driver. planIdSchema: type: string pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$ planSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/planIdSchema' description: The unique identifier of the plan. title: type: string description: The title of the plan. starts: $ref: '#/components/schemas/dateSchema' depot: anyOf: - $ref: '#/components/schemas/depotIdSchema' - type: 'null' description: The depot ID of the plan, in the format depots/ distributed: type: boolean description: Whether the plan has been distributed. writable: type: boolean description: Whether the plan is writable using the normal Plan APIs. If this is false, you will need to use the [Live Plan APIs](/api/v0.2b#tag/Live-Plans) to edit the plan. Any plan created before 2023-04-01 is not writable. optimization: anyOf: - type: string enum: - creating - editing - preview - optimized - optimizing - type: 'null' description: The optimization state of the plan. drivers: type: array items: $ref: '#/components/schemas/driverSchema' description: The driver IDs of the plan, in the format drivers/. routes: type: array items: $ref: '#/components/schemas/routeIdSchema' description: The route IDs of the plan, in the format routes/. required: - id - title - starts - depot - distributed - writable - optimization - drivers - routes additionalProperties: false description: A plan. driverIdSchema: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ dateSchema: type: object properties: day: type: integer minimum: 1 maximum: 31 description: The day of the date. month: type: integer minimum: 1 maximum: 12 description: The month of the date. year: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The year of the date. required: - day - month - year additionalProperties: false description: A date. securitySchemes: BasicAuth: type: http scheme: basic description: Use the API key as the username and leave the password empty.