Containers

Models

Container Model

The container represents a single tracking number with one or more deliveries / shipments nested in it.

object "container"
The description of the model.

coordinates Array<Number, Number>
Array containing [latitude, longitude] coordinates. Defaults to null if coordinates are not available.

created_at integer
Time in epoch seconds when this container was created.

estimated_delivery_at integer
Estimated delivery time in epoch seconds.

id string
Unique identifier for the container, prefixed with ctnr_.

updated_at integer
Time in epoch seconds when this container was last updated.

updated_by string
The ID of the user or key who last updated the container.

organization_id string
Unique identifier for the organization that owns this container.

status string
Current status for this container. Defaults to created. See Statuses.

tracking_number string
Provider-specific string used to track this container.

shipment_ids string[]
Array of shipment IDs associated with this container.

tracking_updates TrackingUpdate[]
A list of waypoints this container has passed through, ordered from oldest to newest. See tracking update model for more details.

location_id string
The hub location to which this container is assigned.

layout_id string
The ID of the layout where this container is being stored.

user_id string
Combined identifier created from organization_id and profile_id. Only set when a profile_id exists.

metadata object
Custom key-value pairs for additional container data.

_search object
A special property that will be included if searching through containers. This is a flat object that contains various properties related to the search results. Each property may include <mark> tags around characters that have matched the search query, allowing for easy highlighting in the user interface. The properties within this object provide relevant information about the search results, such as tracking numbers, metadata, relevance score, and the original query used for the search.

Show Details


_search.tracking_number `string` The tracking number that matched the search query.
_search.relevance_score `number` A numeric value between 0 and 1 that indicates the relevance of a search result to the query, where 1 represents a perfect match and higher values indicate better matches.
_search.query `string` The original search query used to find matching containers.

checksum string
A hash value computed from the current container configuration. This value gets updated whenever the container changes.

Models

# Container Model

Container Model