Optimization runs
A multi-vehicle route optimization request, with its input revision and provider reference.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Input revision | inputRevision | Text | Yes | |
| Integration | logisticsintegrationId | Reference | ||
| Status | status | Constant | Yes | Lifecycle or processing state from the allowed values for this record. |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Applied by | processedBy | User | ||
| Applied at | processedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Integration logisticsintegrationId | Logistics integrations | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsrouteoptimizationruns.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new optimization run. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this optimization run. | App · WebMCP · API · CLI |
| Apply | process | Apply the proposed routes to the shipments. | App · WebMCP · API · CLI |
| Archive | archive | Retire this optimization run from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · CLI |
| Restore | unarchive | Return this optimization run to active lists and actions. | App · WebMCP · API · CLI |
| Delete | delete | Delete this optimization run and the data that belongs with it. This cannot be undone. | App · WebMCP · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.