Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info |
---|
Warning! Resource available only in the following countries: PL, IT |
On this page
Table of Contents |
---|
Template List
Template search can be performed by specifying one or more of the following criteria.
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/shipment_templates |
Search criteria
Parameter | Type | Description | Example | Availability |
---|---|---|---|---|
| String | Searches templates containing the given string in their name. |
| PL, IT |
| String | Searches templates containing the given string in their status. |
| PL, IT |
Result sorting
Search results can be sorted using the sort_by
parameter using the following values:
sort_by value | Effect | Example | Availability |
---|---|---|---|
| Sorts by id. |
| PL, IT |
| Sorts by name. |
| PL, IT |
| Sorts by status. |
| PL, IT |
| Sorts by creation date and time. |
| PL, IT |
| Sorts by last update date and time. |
| PL, IT |
Sorting can be descending or ascending and is controlled by the sort_order
parameter. By default, the sorting order is descending on the created_at
attribute.
sort_order value | Effect | Example | Availability |
---|---|---|---|
| Ascending sorting. |
| PL, IT |
| Descending sorting. |
| PL, IT |