Assign an order to a driver.

This endpoint assigns an order to a driver. Call it once the user has confirmed the order and the driver.
Find the driverId with GET api/v1/drivers/search and check its driverStatus first: an Offline driver can
still be assigned. Assigning an order that already has another driver replaces that driver. The assignment
is refused with a message for, among others, a routed, multi-segment, delivered, cancelled, invoiced or
on-hold order, an unknown or archived driver, or a driver with missing attributes, expired documents, failed
certifications or not enough capacity. Assigning notifies the driver and the replaced driver, and may email
or text the order contacts; when the driver profile auto-accepts dispatched orders, the order is also
accepted. On success the response has no body; an unknown orderId returns a 404. Send no request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the order, as returned by POST api/v1/search/orders.

string
required

The id of the driver, as returned by GET api/v1/drivers/search.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

The order is assigned to the driver.

404

No order has this id.

500

An error occurred when trying to assign the order.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json