Reset Order

POST 
/v1/order/reset

Reset Order EP

Resets the order in S&D. Requires either order_id or order_number.

Resets an order that has been assigned to a carrier or driver, removing BOLs and restoring the order to its pre-dispatch state.

Required Scopes (io.w)

Request

order_id: str | None
The unique identifier of the order to reset

---

order_number: int | None
The order number of the order to reset

Response

Returns None for carrier orders. For driver-assigned orders, returns the updated driver schedule information.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

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

Loading...