openapi: 3.1.0 info: title: Spoke Depots Unassigned Stops 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: Unassigned Stops description: 'Endpoints to operate on [Unassigned Stop](/docs/models/unassignedStop) resources. ' paths: /unassignedStops/{unassignedStopId}: get: operationId: getUnassignedStop summary: Retrieve an unassigned stop tags: - Unassigned Stops description: Retrieve an unassigned stop parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: unassignedStopId required: true description: The unassigned stop id responses: '200': description: The requested unassigned stop content: application/json: schema: $ref: '#/components/schemas/unassignedStopSchema' description: The requested unassigned stop '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 '404': description: The provided unassigned stop id does not exist content: application/json: schema: type: object properties: message: type: string enum: - Unassigned stop not found required: - message description: The provided unassigned stop id does not exist '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: deleteUnassignedStop summary: Delete an unassigned stop tags: - Unassigned Stops description: Delete an unassigned stop. This action cannot be undone and will delete all the data associated with the unassigned stop. parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: unassignedStopId required: true description: The unassigned stop id responses: '204': description: Unassigned Stop 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 '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The error message. required: - message description: 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 patch: operationId: updateUnassignedStop summary: Update an existing unassigned stop tags: - Unassigned Stops description: Does not support updating a unassigned stop's location, nor the `circuitClientId`. To do so, delete the unassignedStop and create a new one. requestBody: content: application/json: schema: description: The request body for updating an unassigned stop. All the values present in the request will update the unassigned stop value. If you wish to update only certain fields, only set those and do not set the others. Any fields not set will not be updated. type: object properties: recipient: anyOf: - description: Recipient information for this stop type: object properties: externalId: description: External ID of the recipient, as defined by the API user anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' email: description: Email of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' phone: description: Phone number of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' name: description: Name of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' orderInfo: anyOf: - description: Order information for this stop type: object properties: products: description: Products in this stop maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 sellerOrderId: description: Seller order ID anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerName: description: Seller name anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerWebsite: description: Seller website anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' paymentOnDelivery: anyOf: - description: Payment on delivery (also known as "Cash on Delivery") data for this stop type: object properties: amount: description: Amount *in minor units* (e.g. cents) to be collected upon delivery anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' currency: description: Currency of the payment. Defaults to the team's 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: 'null' additionalProperties: false - type: 'null' proofOfAttemptRequirements: anyOf: - description: Proof of attempt requirement settings for this stop type: object properties: enabled: description: Whether proof of attempt is required for this stop anyOf: - type: boolean - type: 'null' additionalProperties: false - type: 'null' allowedDrivers: description: Driver IDs that are allowed to be assigned to this stop. If not provided, the stop will be assigned to any available driver during optimization. anyOf: - maxItems: 100 type: array items: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' activity: description: Activity type default: delivery anyOf: - type: string enum: - delivery - pickup - type: 'null' optimizationOrder: description: The preferred order of this stop in the optimized route. If not provided or `"default"`, the stop will be placed in the optimal order, decided by the optimization algorithm. Otherwise it will be placed either `"first"` or `"last"`. anyOf: - type: string enum: - first - last - default - type: 'null' packageCount: description: Number of packages in the stop anyOf: - type: number minimum: 1 maximum: 10000 - type: 'null' weight: description: Weight information for this stop. anyOf: - type: object properties: amount: description: The weight amount for this stop. type: number minimum: 0 maximum: 999999 multipleOf: 0.01 unit: description: The weight unit in which the amount is specified. type: string enum: - kilogram - pound - metric-ton required: - amount - unit - type: 'null' notes: description: Notes for the stop anyOf: - type: string minLength: 1 maxLength: 2000 - type: 'null' barcodes: description: List of barcode IDs associated with this stop maxItems: 200 type: array items: type: string minLength: 1 maxLength: 255 customProperties: description: Key-value pairs of custom stop properties for this stop. The keys must be unique and match a custom stop property defined in your team. anyOf: - type: object propertyNames: description: The custom stop property id type: string maxLength: 50 additionalProperties: description: The value of the custom stop property, up to 255 characters. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' - type: 'null' timing: anyOf: - type: object properties: earliestAttemptTime: description: Time of day of the earliest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' latestAttemptTime: description: Time of day of the latest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' estimatedAttemptDuration: description: Duration in seconds of the activity in this stop, only set if you want to override the default. This can be set up to 8 hours. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' additionalProperties: false - type: 'null' depot: description: The Depot ID that this unassigned stop belongs to, in the format `depot/`. If null, it will default to the team's main depot. If not provided, it will not be updated. anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' additionalProperties: false description: The request body for updating an unassigned stop. All the values present in the request will update the unassigned stop value. If you wish to update only certain fields, only set those and do not set the others. Any fields not set will not be updated. parameters: - schema: type: string pattern: ^[a-zA-Z0-9---_]{1,50}$ in: path name: unassignedStopId required: true description: The unassigned stop id responses: '200': description: The updated unassigned stop content: application/json: schema: $ref: '#/components/schemas/unassignedStopSchema' description: The updated unassigned stop '400': description: The request has errors. Either syntactic or semantic 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 request has errors. Either syntactic or semantic 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: The request contains fields that are not supported by your team subscription/settings. content: application/json: schema: oneOf: - type: object properties: message: type: string description: The error message. code: type: string enum: - feature_not_in_subscription url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Feature not included in your team subscription - type: object properties: message: type: string description: The error message. code: type: string enum: - vehicle_capacity_disabled url: type: string enum: - https://dispatch.spoke.com/settings/team-profile required: - message - code - url description: Vehicle capacity mode is disabled in the team's settings description: The request contains fields that are not supported by your team subscription/settings. '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The error message. required: - message description: 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 /unassignedStops: get: operationId: listUnassignedStops summary: List unassigned stops tags: - Unassigned Stops parameters: - schema: type: string minLength: 1 maxLength: 255 in: query name: pageToken required: false description: The page token to continue from. - schema: default: 20 type: number minimum: 1 maximum: 20 in: query name: maxPageSize required: false description: The maximum number of unassigned stops to return per page. - schema: type: object properties: externalId: description: Filter by the `recipient.externalId` field, exact match type: string minLength: 1 maxLength: 255 in: query name: filter required: false description: The filter to apply to the list of unassigned stops. responses: '200': description: Success content: application/json: schema: type: object properties: unassignedStops: type: array items: $ref: '#/components/schemas/unassignedStopSchema' description: The unassignedStops. nextPageToken: anyOf: - type: string - type: 'null' description: The next page token. required: - unassignedStops - nextPageToken definitions: unassignedStopSchema: type: object properties: id: type: string pattern: ^unassignedStops\/[a-zA-Z0-9---_]{1,50}$ description: The id of the unassigned stop, in the format `unassignedStops/`. depot: type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ description: The depot that this unassigned stop belongs to. 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. allowedDriversIdentifiers: type: array items: type: string description: The allowed drivers that can be assigned to 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' orderInfo: type: object properties: products: type: array items: type: string description: The products of the stop. 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 - sellerName - sellerOrderId - sellerWebsite additionalProperties: false description: The order information of the stop. 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 trackingLink: anyOf: - type: string - type: 'null' description: The recipient tracking link. 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 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. 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. circuitClientId: anyOf: - type: string - type: 'null' description: The associated Client ID of the Spoke Connect required: - id - depot - address - barcodes - allowedDriversIdentifiers - notes - packageCount - weight - orderInfo - recipient - trackingLink - timing - paymentOnDelivery - proofOfAttemptRequirements - customProperties - circuitClientId additionalProperties: false description: An unassigned stop. 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 post: operationId: createUnassignedStop summary: Create a new unassigned stop tags: - Unassigned Stops description: Create a new unassigned stop with the given data. requestBody: content: application/json: schema: description: The request body for creating an unassigned stop. Address is a required field, you need to provide at least one of the fields in it. The latitude and longitude fields will override any of the other fields if they are set (and they need to be both set if any of them are). The more fields you provide the more accurate the geocoding will be. The depotId field is not required, but will default to the main depot of the team if not provided, be sure to provide it if you want to use a different depot. type: object properties: address: type: object properties: addressName: description: The name of the address. This will not be used for geocoding, and is only for the final address display purposes. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' addressLineOne: description: The first line of the address. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' addressLineTwo: description: The second line of the address. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' city: description: The city of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' state: description: The state of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' zip: description: The zip code of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' country: description: The country of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' latitude: description: The latitude of the address in decimal degrees. anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' longitude: description: The longitude of the address in decimal degrees. anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' additionalProperties: false depot: description: The Depot ID that this unassigned stop belongs to, in the format `depot/`. If not provided, or null, it will default to the team's main depot. anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' timing: anyOf: - description: Timing information for this stop type: object properties: earliestAttemptTime: description: Time of day of the earliest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' latestAttemptTime: description: Time of day of the latest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' estimatedAttemptDuration: description: Duration in seconds of the activity in this stop, only set if you want to override the default. This can be set up to 8 hours. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' additionalProperties: false - type: 'null' recipient: anyOf: - description: Recipient information for this stop type: object properties: externalId: description: External ID of the recipient, as defined by the API user anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' email: description: Email of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' phone: description: Phone number of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' name: description: Name of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' orderInfo: anyOf: - description: Order information for this stop type: object properties: products: description: Products in this stop maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 sellerOrderId: description: Seller order ID anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerName: description: Seller name anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerWebsite: description: Seller website anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' paymentOnDelivery: anyOf: - description: Payment on delivery (also known as "Cash on Delivery") data for this stop type: object properties: amount: description: Amount *in minor units* (e.g. cents) to be collected upon delivery anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' currency: description: Currency of the payment. Defaults to the team's 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: 'null' additionalProperties: false - type: 'null' proofOfAttemptRequirements: anyOf: - description: Proof of attempt requirement settings for this stop type: object properties: enabled: description: Whether proof of attempt is required for this stop anyOf: - type: boolean - type: 'null' additionalProperties: false - type: 'null' allowedDrivers: description: Driver IDs that are allowed to be assigned to this stop. If not provided, the stop will be assigned to any available driver during optimization. anyOf: - maxItems: 100 type: array items: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' activity: description: Activity type default: delivery anyOf: - type: string enum: - delivery - pickup - type: 'null' optimizationOrder: description: The preferred order of this stop in the optimized route. If not provided or `"default"`, the stop will be placed in the optimal order, decided by the optimization algorithm. Otherwise it will be placed either `"first"` or `"last"`. anyOf: - type: string enum: - first - last - default - type: 'null' packageCount: description: Number of packages in the stop anyOf: - type: number minimum: 1 maximum: 10000 - type: 'null' weight: description: Weight information for this stop. anyOf: - type: object properties: amount: description: The weight amount for this stop. type: number minimum: 0 maximum: 999999 multipleOf: 0.01 unit: description: The weight unit in which the amount is specified. type: string enum: - kilogram - pound - metric-ton required: - amount - unit - type: 'null' notes: description: Notes for the stop anyOf: - type: string minLength: 1 maxLength: 2000 - type: 'null' circuitClientId: description: Client ID of the retailer in Spoke Connect anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' barcodes: description: List of barcode IDs associated with this stop maxItems: 200 type: array items: type: string minLength: 1 maxLength: 255 customProperties: description: Key-value pairs of custom stop properties for this stop. The keys must be unique and match a custom stop property defined in your team. anyOf: - type: object propertyNames: description: The custom stop property id type: string maxLength: 50 additionalProperties: description: The value of the custom stop property, up to 255 characters. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' - type: 'null' required: - address additionalProperties: false required: true description: The request body for creating an unassigned stop. Address is a required field, you need to provide at least one of the fields in it. The latitude and longitude fields will override any of the other fields if they are set (and they need to be both set if any of them are). The more fields you provide the more accurate the geocoding will be. The depotId field is not required, but will default to the main depot of the team if not provided, be sure to provide it if you want to use a different depot. responses: '200': description: The created unassignedStop content: application/json: schema: $ref: '#/components/schemas/unassignedStopSchema' description: The created unassignedStop '400': description: The request has errors. Either syntactic or semantic 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 request has errors. Either syntactic or semantic '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: The request contains fields that are not supported by your team subscription/settings. content: application/json: schema: oneOf: - type: object properties: message: type: string description: The error message. code: type: string enum: - feature_not_in_subscription url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Feature not included in your team subscription - type: object properties: message: type: string description: The error message. code: type: string enum: - vehicle_capacity_disabled url: type: string enum: - https://dispatch.spoke.com/settings/team-profile required: - message - code - url description: Vehicle capacity mode is disabled in the team's settings description: The request contains fields that are not supported by your team subscription/settings. '404': description: The driver or depot could not be found. content: application/json: schema: oneOf: - 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 x-response-description: The provided driver id does not exist - type: object properties: message: type: string enum: - Depot not found required: - message description: The provided depot id does not exist title: Depot not found x-response-description: The provided depot id does not exist - type: object properties: message: type: string enum: - Main depot not found code: type: string enum: - main_depot_not_found required: - message - code description: The team has no main depot configured title: Main depot not found description: The driver or depot could not be found. '422': description: Failed to create stop content: application/json: schema: type: object properties: message: anyOf: - type: string enum: - An error occurred when creating the unassigned stop, but the error is not due to a validation error, instead it is another conflict, check if the provided data is semantically valid. - type: string required: - message description: Failed to create stop '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 /unassignedStops:import: post: operationId: importUnassignedStops summary: Batch import unassigned stops tags: - Unassigned Stops description: Batch import unassigned stops. The request body must contain an array of unassigned stops to import. Note that the `depot` is the same for all unassigned stops in a same request. This is because the depot is used as a biasing location for the unassigned stops, so that the geocoding results are more accurate for a same region. requestBody: content: application/json: schema: type: object properties: unassignedStops: description: An array of unassigned stops to import in batch. Supports a maximum of 100 unassigned stops per request. Note that the `depot` is shared across all unassigned stops in the request, and thus should not be provided for individual unassigned stops. That is because the `depot` location is used to bias the geocoding results of the stops. minItems: 1 maxItems: 100 type: array items: type: object properties: address: type: object properties: addressName: description: The name of the address. This will not be used for geocoding, and is only for the final address display purposes. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' addressLineOne: description: The first line of the address. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' addressLineTwo: description: The second line of the address. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' city: description: The city of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' state: description: The state of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' zip: description: The zip code of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' country: description: The country of the address. anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' latitude: description: The latitude of the address in decimal degrees. anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' longitude: description: The longitude of the address in decimal degrees. anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' additionalProperties: false timing: anyOf: - description: Timing information for this stop type: object properties: earliestAttemptTime: description: Time of day of the earliest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' latestAttemptTime: description: Time of day of the latest time this stop should happen anyOf: - description: Time of day in hours and minutes. Use a 24 hour clock. type: object properties: hour: description: Hour of the day type: integer minimum: -9007199254740991 maximum: 9007199254740991 minute: description: Minute of the hour type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - hour - minute additionalProperties: false - type: 'null' estimatedAttemptDuration: description: Duration in seconds of the activity in this stop, only set if you want to override the default. This can be set up to 8 hours. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' additionalProperties: false - type: 'null' recipient: anyOf: - description: Recipient information for this stop type: object properties: externalId: description: External ID of the recipient, as defined by the API user anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' email: description: Email of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' phone: description: Phone number of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' name: description: Name of the recipient anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' orderInfo: anyOf: - description: Order information for this stop type: object properties: products: description: Products in this stop maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 sellerOrderId: description: Seller order ID anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerName: description: Seller name anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' sellerWebsite: description: Seller website anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' additionalProperties: false - type: 'null' paymentOnDelivery: anyOf: - description: Payment on delivery (also known as "Cash on Delivery") data for this stop type: object properties: amount: description: Amount *in minor units* (e.g. cents) to be collected upon delivery anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' currency: description: Currency of the payment. Defaults to the team's 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: 'null' additionalProperties: false - type: 'null' proofOfAttemptRequirements: anyOf: - description: Proof of attempt requirement settings for this stop type: object properties: enabled: description: Whether proof of attempt is required for this stop anyOf: - type: boolean - type: 'null' additionalProperties: false - type: 'null' allowedDrivers: description: Driver IDs that are allowed to be assigned to this stop. If not provided, the stop will be assigned to any available driver during optimization. anyOf: - maxItems: 100 type: array items: type: string pattern: ^drivers\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' activity: description: Activity type default: delivery anyOf: - type: string enum: - delivery - pickup - type: 'null' optimizationOrder: description: The preferred order of this stop in the optimized route. If not provided or `"default"`, the stop will be placed in the optimal order, decided by the optimization algorithm. Otherwise it will be placed either `"first"` or `"last"`. anyOf: - type: string enum: - first - last - default - type: 'null' packageCount: description: Number of packages in the stop anyOf: - type: number minimum: 1 maximum: 10000 - type: 'null' weight: description: Weight information for this stop. anyOf: - type: object properties: amount: description: The weight amount for this stop. type: number minimum: 0 maximum: 999999 multipleOf: 0.01 unit: description: The weight unit in which the amount is specified. type: string enum: - kilogram - pound - metric-ton required: - amount - unit - type: 'null' notes: description: Notes for the stop anyOf: - type: string minLength: 1 maxLength: 2000 - type: 'null' circuitClientId: description: Client ID of the retailer in Spoke Connect anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' barcodes: description: List of barcode IDs associated with this stop maxItems: 200 type: array items: type: string minLength: 1 maxLength: 255 customProperties: description: Key-value pairs of custom stop properties for this stop. The keys must be unique and match a custom stop property defined in your team. anyOf: - type: object propertyNames: description: The custom stop property id type: string maxLength: 50 additionalProperties: description: The value of the custom stop property, up to 255 characters. anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' - type: 'null' required: - address additionalProperties: false depot: description: The Depot ID the unassigned stops in the batch belong to, in the format `depot/`. This is used to bias the geocoding results of the unassigned stops, so every unassigned stop in the batch should belong to the same depot. If not provided, or null, it will default to the team's main depot. anyOf: - type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ - type: 'null' required: - unassignedStops additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: type: object properties: success: type: array items: type: string pattern: ^unassignedStops\/[a-zA-Z0-9---_]{1,50}$ description: The id of the unassigned stop, in the format `unassignedStops/`. description: The ids of the successfully imported unassigned stops failed: type: array items: type: object properties: error: type: object properties: message: type: string description: The error that occurred during import required: - message unassignedStop: type: object properties: address: type: object properties: addressName: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: The name of the address. This will not be used for geocoding, and is only for the final address display purposes. addressLineOne: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: The first line of the address. addressLineTwo: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: The second line of the address. city: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' description: The city of the address. state: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' description: The state of the address. zip: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' description: The zip code of the address. country: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' description: The country 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. required: - addressName - addressLineOne - addressLineTwo - city - state - zip - country - latitude - longitude additionalProperties: false description: The address of the unassigned stop that failed to import recipient: anyOf: - type: object properties: externalId: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: External ID of the recipient, as defined by the API user email: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: Email of the recipient phone: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: Phone number of the recipient name: anyOf: - type: string minLength: 1 maxLength: 255 - type: 'null' description: Name of the recipient required: - externalId - email - phone - name additionalProperties: false - type: 'null' description: The recipient of the unassigned stop that failed to import required: - address - recipient description: The unassigned stop that failed to import required: - error - unassignedStop description: The failed unassigned stops required: - success - failed description: Success '400': description: The request has errors. Either syntactic or semantic 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 request has errors. Either syntactic or semantic '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: The request contains fields that are not supported by your team subscription/settings. content: application/json: schema: oneOf: - type: object properties: message: type: string description: The error message. code: type: string enum: - feature_not_in_subscription url: type: string enum: - https://dispatch.spoke.com/paywall required: - message - code - url description: Feature not included in your team subscription - type: object properties: message: type: string description: The error message. code: type: string enum: - vehicle_capacity_disabled url: type: string enum: - https://dispatch.spoke.com/settings/team-profile required: - message - code - url description: Vehicle capacity mode is disabled in the team's settings description: The request contains fields that are not supported by your team subscription/settings. '404': description: A depot or a driver was not found content: application/json: schema: type: object properties: message: type: string description: The error message. required: - message description: A depot or a driver was not found '422': description: Failed to create stop content: application/json: schema: type: object properties: message: anyOf: - type: string enum: - An error occurred when creating the unassigned stop, but the error is not due to a validation error, instead it is another conflict, check if the provided data is semantically valid. - type: string required: - message description: Failed to create stop '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: unassignedStopSchema: type: object properties: id: allOf: - $ref: '#/components/schemas/unassignedStopIdSchema' description: The id of the unassigned stop, in the format `unassignedStops/`. depot: type: string pattern: ^depots\/[a-zA-Z0-9---_]{1,50}$ description: The depot that this unassigned stop belongs to. 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. allowedDriversIdentifiers: type: array items: type: string description: The allowed drivers that can be assigned to 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' orderInfo: type: object properties: products: type: array items: type: string description: The products of the stop. 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 - sellerName - sellerOrderId - sellerWebsite additionalProperties: false description: The order information of the stop. 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 trackingLink: anyOf: - type: string - type: 'null' description: The recipient tracking link. 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 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. 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. circuitClientId: anyOf: - type: string - type: 'null' description: The associated Client ID of the Spoke Connect required: - id - depot - address - barcodes - allowedDriversIdentifiers - notes - packageCount - weight - orderInfo - recipient - trackingLink - timing - paymentOnDelivery - proofOfAttemptRequirements - customProperties - circuitClientId additionalProperties: false description: An unassigned stop. 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. unassignedStopIdSchema: type: string pattern: ^unassignedStops\/[a-zA-Z0-9---_]{1,50}$ securitySchemes: BasicAuth: type: http scheme: basic description: Use the API key as the username and leave the password empty.