Order Status Update Ep

POST /v1/order/update_status

Order Status Update

Updates the status of an order and its stops.

Required Scopes (io.w)

order_id: str
Unique identifier for the order.

order_number: str | None = None
Order number.

status: StatusUpdate
Status of the order.

Show Statuses

driving_to_load
The driver is driving to the terminal.

arrived_at_load
The driver has arrived at the terminal.

loading
The driver is loading the product at the terminal.

completed_load
The driver has completed loading the product.

driving_to_drop
The driver is driving to the drop site.

arrived_at_drop
The driver has arrived at the drop site.

dropping
The driver is dropping the product.

completed_drop
The driver has completed dropping the product.

complete
The order is complete.

location_id: str | None = None
Unique identifier for the location.

eta: datetime | None = None
Estimated time of arrival.

Details

Passing eta in the local timezone

If the field is provided as eta_local instead, the system will convert it to UTC based on the location's timezone.

actual: datetime | None = None
Actual time of arrival.

Details

Passing actual in the local timezone

If the field is provided as actual_local instead, the system will convert it to UTC based on the location's timezone.

Successful Response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}