Finds and returns unique identifiers for all Orders that match a given criteria.
| Get | api/orders |
Resource Path: /sites/{company-id}/api/orders
Uri: https://secure.ontime360.com/sites/{company-id}/api/orders
| Name | Description | Data Type |
|---|---|---|
| customerName | The name of the Customer assigned to an Order as a String. | string |
| collectionLocation | The unique identifier of the collection Location assigned to an Order as a Guid. | string |
| dateSubmitted | The exact date that an Order was made as a Date | string |
| dateSubmittedMin | The inclusive lower-bound of a Payment date as a Date. | string |
| dateSubmittedMax | The inclusive upper-bound of a Payment date as a Date. | string |
| deliveryLocation | The unique identifier of the delivery Location assigned to an Order as a Guid. | string |
| driverCurrentlyAssigned | The unique identifier of the User currently assigned to an Order as a Guid. | string |
| incomingTrackingNumber | The incoming tracking number of an Order as a String. | string |
| outgoingTrackingNumber | The outgoing tracking number of an Order as a String. | string |
| purchaseOrderNumber | The purchase order number of an Order as a String. | string |
| referenceNumber | The reference number of an Order as a String. | string |
| status | The status of an Order as a pre-defined String, or as a pre-defined Integer. Status Values: 0 - None 1 - Dispatched 2 - AssignedInRoute 3 - Delivered 4 - Cancelled 5 - CancelledBillable 6 - Assigned 7 - Stored 8 - UnassignedStored 9 - Quoted Available Values: [None, Dispatched, AssignedInRoute, Delivered, Cancelled, CancelledBillable, Assigned, Stored, UnassignedStored, Quoted] | string |
| trackingNumber | The tracking number of the orders. | string |
The response body is of type Array[].
An array of unique Guid identifiers assigned to matching Order objects.| 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. |