Warning! Resource available only in the following countries: PL |
On this page
Search for dispatch orders is done by specifying one or more of the following criteria
Warning Debit clients! We do not return prices for debit clients.
|
GET /v1/organizations/:organization_id/dispatch_orders |
Search criteria
Parameter | Type | Description | Example | Availability |
---|---|---|---|---|
| Integer Array | Searches for the dispatch order with the stated ID. Searches for dispatch orders with the stated IDs. |
| PL |
| Date | Searches for dispatch orders created on the given day. |
| PL |
| Time | Searches for dispatch orders in which the time created is >= specified time. The time can be provided in the ISO 8601 or similar format, and as a timestamp. |
| PL |
| Time | Searches for dispatch orders created earlier than at the specified time. The time can be provided in the ISO 8601 or similar format, and as a timestamp. |
| PL |
| String Array | Searches for dispatch orders in the specified status. Searches for dispatch orders in one of the indicated statuses. |
| PL |
| String | Searches for dispatch orders for which the address (street) starts with the given string. |
| PL |
| String | Searches for dispatch orders for which the post-code starts with the given string. |
| PL |
| String | Searches for dispatch orders for which the country code is the same as the specified string. |
| PL |
| String | Searches for dispatch orders for which the city is the same as the specified string. |
| PL |
| Integer Array | Searches for dispatch orders that include shipment with the given id. Searches for dispatch orders that include shipments with the given ids. |
| PL |
| String Array | Searches for dispatch orders that include shipment with the given tracking number. Searches for dispatch orders that include shipments with the given tracking numbers. |
| PL |
| String Array | Searches for dispatch orders that include shipments with at least one of the given services.
|
| PL |
| String Array | Searches for dispatch orders in the given state
|
| PL |
Sorting results
Search result sorting can be facilitated using the sort_by
attribute, which can take the following values:
sort_by value | Description | Example | Availability |
---|---|---|---|
| Sorts by id |
| PL |
| Sorts by creation date and time |
| PL |
| Sorts by address |
| PL |
| Sorts by post code |
| PL |
| Sorts by country code |
| PL |
| Sorts by first shipment id |
| PL |
| Sorts by first shipment tracking number |
| PL |
Sort ordering can be set using sort_order
attribute. By default, the results are sorted in descending order using the created_at
field.
sort_order value | Description | Example | Availability |
---|---|---|---|
| Sorts in ascending order |
| PL |
| Sorts in descending order |
| PL |