Updates the current status of an existing Order.
| Post | api/order/updateStatus |
Resource Path: /sites/{company-id}/api/order/updateStatus
Uri: https://secure.ontime360.com/sites/{company-id}/api/order/updateStatus
| Name | Description | Data Type |
|---|---|---|
id (query) | The unique identifier of the Order as a Guid. | string |
trackingNumber (query) | The tracking number assigned to the Order as a String. | string |
label (query) | The new label assigned to the status update as a String. | string |
detail (query) | The new status of an Order as a pre-defined String, or as a pre-defined Integer. Available Values: [None, Dispatched, AssignedInRoute, Delivered, Cancelled, CancelledBillable, Assigned, Stored, UnassignedStored, Quoted] | string |
date (query) | The exact date that the status change occurred as a Date. | string |
The request body is of type object.
The response body is of type object.
Returns true if the Order's status was successfully updated. Otherwise, returns false.| Fault | Description |
|---|---|
| 400 | Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information. |
| 401 | Authorization key is invalid or no longer exists. |
| 403 | Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information. |