Containers
Retrieve Container
Retrieving a single container uses the id
of the container to get it.
Retrieve containerGET `/v1/containers/:container`
Get a single container using its id
.
List containers
ExampleGET `/v1/containers`
When you want to retrieve multiple containers, your data
property on the result will always be an array
even if you don't have any containers. The containers are returned in descending order, meaning the latest container that was created will be first.
Pagination
If the has_more
property on the pagination object is set to true, you know there are more containers in the database that have not been returned to you. The pagination object also has a page
property indicating your current offset and a limit property.
By default the page
is set to 1
and the limit
is 25
.
If we want to query for containers 26 - 50, we would request page 2 with a query parameter.
Filter
You can filter containers by location_id
and statuses
.
- location_id - Add the ID of one of your locations to get all of the containers currently mapped to that location. For example:
location_id=loc_czhgjrk5JaVvyATPDbyURp
- statuses - A comma separated list of shipment statuses. Keep in mind comma's in URLs are encoded as
%2C
, so we recommend using your platforms native URL encoding library. For example: statuses=delivered%2Cpicked_up
Sorting
Sorting describes in what order you want your responses to come in. You can select an available property by which to sort, as well as the direction.
- order_by - The property by which to sort. Available properties are:
created_at
- direction - The direction to sort. Available directions are:
asc
anddesc
By default, containers will be sorted by in descending order, meaning the most recently created will be first.