Unassigned Stop Schema

Model

UnassignedStop

Ƭ UnassignedStop: Object

The Unassigned Stop data model. All Unassigned Stops in the API will have this format.

Description

An unassigned stop is a location that a driver will visit. However the unassigned stop is not yet associated with a plan or route, so it cannot be optimized until assigned.

Notice that in the current version of the API it is not possible to assign stops to a plan directly. The only way to assign a stop to a plan currently is to use the web UI. For now the unassigned stops API operations only allow to create, list, update and delete unassigned stops.

Example

{
  "id": "unassignedStops/zeOCJaJCzZhpKVCVAC9o",
  "depot": "depots/gjaqksJIa26qGPzsgBXT",
  "address": {
    "address": "Very nice St., 150 - Nice Neighbourhood, Campinas - SP, 130876, Brazil",
    "placeId": "1cda3f263368264eefbb",
    "latitude": -22.12345,
    "longitude": -47.12345,
    "placeTypes": [
      "street_address"
    ],
    "addressLineOne": "Very nice St., 150",
    "addressLineTwo": "Nice Neighbourhood, Campinas - SP, 130876, Brazil"
  },
  "notes": null,
  "timing": {
    "estimatedAttemptDuration": 300,
    "earliestAttemptTime": {
      "hour": 8,
      "minute": 0,
    },
    "latestAttemptTime": {
      "hour": 10,
      "minute": 0,
    }
  },
  "orderInfo": {
    "products": ["Taco"],
    "sellerName": "Sam's Taco Truck",
    "sellerOrderId": "ON-2301",
    "sellerWebsite": "https://sams.taco"
  },
  "packageCount": 5,
  "activity": "delivery",
  "recipient": {
    "email": "alvena.schulist33@getcircuit.com",
    "externalId": "The recipient's ID on your system",
    "name": "Alvena Schulist",
    "phone": "+1-555-555-5555"
  },
  "circuitClientId": "pjaqksJIa26qGPzsgBXT"
}

Type declaration

Name	Type	Description
id	UnassignedStopId	The stop identifier.
depot	DepotId	The depot that this unassigned stop belongs to.
address	UnassignedStopAddress	Object containing the address of the stop.
allowedDriversIdentifiers	string[]	An array of driver identifiers. Either email or phone of a driver. This information is used to force a specific stop in a plan to be assigned only to specific drivers. If no drivers are listed here, the stop will be assigned to any driver. Default ts []
timing	TimingData	Timing information for the stop
notes	string | null	Notes for the delivery. Default ts null
orderInfo	OrderInfo	Information of the order made by the recipient. Default ts null
packageCount	number | null	Amount of packages to be delivered in the stop. Default ts null
recipient	UnassignedStopRecipient	The recipient of the delivery.
activity	UnassignedStopActivity	The activity performed at the stop by the driver. Default ts 'delivery'
optimizationOrder	"first" | "last" | "default"	The preferred order of the stop after optimizing the route. Description first: The stop will be placed at the start of the route. last: The stop will be placed at the end of the route. default: The stop will be placed in an optimal position based on the route optimization algorithm. Default ts 'default'
circuitClientId	string | null	If set, the stop will be associated with the Circuit Client Portal with the given Client ID.

Identifier

DepotId

Ƭ DepotId: `depots/${string}`

A depot id is a string that is unique for a depot. It is used to identify the depot in the API.

Example

"depot/0xBYy4MYt4piMCSQEsts"

---

UnassignedStopId

Ƭ UnassignedStopId: `unassignedStops/${string}`

An Unassigned Stop id is a string that is unique for each Unassigned Stop. It is used to identify the Unassigned Stop in the API.

Example

"unassignedStops/rpX5zK2kRFlIfwREp1js"

Fields

UnassignedStopAddress

Ƭ UnassignedStopAddress: Object

Data used to identify the stop location.

Example

{
  "address": "Very nice St., 150 - Nice Neighbourhood, Campinas - SP, 130876, Brazil",
  "placeId": "1cda3f263368264eefbb",
  "latitude": -22.12345,
  "longitude": -47.12345,
  "placeTypes": [
    "street_address"
  ],
  "addressLineOne": "Very nice St., 150",
  "addressLineTwo": "Nice Neighbourhood, Campinas - SP, 130876, Brazil"
},

Type declaration

Name	Type	Description
address	string	Combined address string. Default ts '' Description It will always be an empty string '' if imported from a spreadsheet using latitude and longitude.
addressLineOne	string	First line of the address. Default ts ''
addressLineTwo	string	Second line of the address. Default ts ''
latitude	number | null	Latitude coordinate of the stop location in decimal degrees. Default ts null
longitude	number | null	Longitude coordinate of the stop location in decimal degrees. Default ts null
placeId	string | null	The identifier of the Place corresponding to this stop on Google Places. Default ts null
placeTypes	string[]	Array of strings that is provided by the Google AutoCompleteAPI. Default ts []

---

UnassignedStopRecipient

Ƭ UnassignedStopRecipient: Object

Information on the recipient of the package.

Example

{
  "email": "alvena.schulist33@getcircuit.com",
  "externalId": "The recipient's ID on your system",
  "name": "Alvena Schulist",
  "phone": "+1-555-555-5555"
}

Type declaration

Name	Type	Description
email	string | null	Email address of recipient Default ts null
externalId	string | null	Id of recipient in external system of the team's company Default ts null
name	string | null	Full name of recipient Default ts null
phone	string | null	Phone number of recipient Default ts null

---

OrderInfo

Ƭ OrderInfo: Object

Information of the order made by the recipient.

Example

{
  "products": ["Taco"],
  "sellerName": "Sam's Taco Truck",
  "sellerOrderId": "ON-2301",
  "sellerWebsite": "https://sams.taco"
}

Type declaration

Name	Type	Description
products	string[]	Name of the products to be delivered. Default ts [] Description To get the products to be split in this array, whether using the Web UI or submitting via a spreadsheet, use a , (comma) or a ; (semicolon) as a delimiter between each product.
sellerOrderId	string | null	The ID of the order created by the seller that is usually shared with the client. Default ts null
sellerName	string | null	Name of the seller where the user bought the products. Default ts null
sellerWebsite	string | null	Website where the user bought the products. Default ts null

---

TimingData

Ƭ TimingData: Object

Timing information for the stop.

Description

The timing information for the stop. This will be used to calculate the optimal time to visit the stop.

Example

{
 "earliestAttemptTime": {
   "hour": 8,
   "minute": 0,
   "second": 0
 },
 "latestAttemptTime": {
   "hour": 10,
   "minute": 0,
   "second": 0
 },
 "estimatedAttemptDuration": 300
}

Type declaration

Name	Type	Description
earliestAttemptTime	TimeOfDay | null	Earliest attemp time this stop should occur at. Default ts null
latestAttemptTime	TimeOfDay | null	Latest attemp time this stop should occur at. Default ts null
estimatedAttemptDuration	number | null	Time that the driver estimates to spend on the stop to do his job (deliver a parcel, visit a client, etc) in seconds. This will only be set if this was overidden for this stop, otherwise this will be null and all the calculations will use the default team value. Default ts null

---

TimeOfDay

Ƭ TimeOfDay: Object

The time of day in hours and minutes.

Description

The time of day in hours and minutes.

Example

{
  "hour": 8,
  "minute": 0
}

Type declaration

Name	Type
hour	number
minute	number

---

UnassignedStopActivity

Ƭ UnassignedStopActivity: "delivery" | "pickup"

The activity performed at the stop by the driver.

Description

• delivery: The driver has to deliver the package
• pickup: The driver has to pick up the package