[1.2.0] Shipment template searching and sorting

Template List

Template search can be performed by specifying one or more of the following criteria.

GET /v1/organizations/:organization_id/shipment_templates

Search criteria

Parameter	Type	Description	Example

Parameter	Type	Description	Example
`name`	String	Searches templates containing the given string in their name.	`?name=mag`
`status`	String	Searches templates containing the given string in their status.	`?status=suspended`

Result sorting

Search results can be sorted using the sort_by parameter using the following values:

sort_by value	Effect	Example

sort_by value	Effect	Example
`id`	Sorts by id.	`?sort_by=id`
`name`	Sorts by name.	`?sort_by=name`
`status`	Sorts by status.	`?sort_by=status`
`created_at`	Sorts by creation date and time.	`?sort_by=created_at`
`updated_at`	Sorts by last update date and time.	`?sort_by=updated_at`

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

sort_order value	Effect	Example
`asc`	Ascending sorting.	`?sort_order=asc&sort_by=id`
`desc`	Descending sorting.	`?sort_order=desc&sort_by=id`

On this page

1 Template List