Containers
Retrieve Container
Retrieve detailed information about a specific container, including its current status, tracking history, and related data using the id
of the container.
Error Handling
If the container doesn't exist or belongs to a different organization:
List containers
Retrieve a paginated list of containers with comprehensive filtering, sorting, and search capabilities. The endpoint returns containers along with their associated data.
Basic Usage
Fetch a list of containers with default pagination and sorting:
Pagination
The API uses page-based pagination to manage large sets of results. Each response includes a pagination object with the following information:
Default pagination settings:
- Page: 1
- Limit: 25 items per page
Example request for the second page:
Filtering Options
The API supports multiple filtering parameters to help narrow down results:
- Location Filtering
Filter containers by their physical location:
location_id
orlocation
: Location identifierlayout_id
orlayout
: Specific layout within a locationlayout_path
: Filter by layout hierarchy path
- Status Filtering
Filter containers by their current status:
status
: Single status filterstatuses
: Comma-separated list of statusesfilter
: Predefined status group filter
- Metadata Filtering
Filter containers based on metadata fields using the metadata query parameter:
Sorting
Control the order of returned results using sort parameters:
Search
The API provides advanced full-text search capabilities through the search parameter, allowing you to search containers using fuzzy, typo-tolerant matching across multiple fields. The search functionality examines key container properties including:
tracking_number
metadata
Each container in the search results includes a special _search
object that provides detailed information about the match:
The _search
object includes highlighted matches using <mark>
tags, making it easy to emphasize matching text in user interfaces. It also provides a relevance score between 0 and 1, where higher values indicate better matches.
By default, search results are ordered by relevance score to show the best matches first. However, you can override this by specifying an order_by parameter to sort by other fields like created_at
, updated_at
, estimated_delivery_at
. The search functionality can be combined with other filter parameters to refine your results further.