Containers

Retrieve Container

Retrieving a single container uses the id of the container to get it.

Retrieve container

GET

`/v1/containers/:container`

Get a single container using its id.

        fetch("https://api.packagex.io/v1/containers/ctnr_czhgjrk5JaVvyATPDbyURp", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
});

List containers

Example

GET

`/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.

        const response = await fetch("https://api.packagex.io/v1/containers", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
}).then((res) => res.json());

const containers = response.data;
const pagination = response.pagination;

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. The total_count property in pagination returns the the total number of containers in the database.

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.

        const response = await fetch("https://api.packagex.io/v1/containers?page=2&limit=25", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
}).then((res) => res.json());

const containers = response.data; //the array of containers 25 - 50
const pagination = response.pagination; //the pagination object

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

        const response = await fetch(
  "https://api.packagex.io/v1/containers?location_id=loc_czhgjrk5JaVvyATPDbyURp&statuses=delivered%2Cpicked_up&page=3",
  {
    method: "GET",
    headers: {
      "PX-API-KEY": process.env.PX_API_KEY,
      "Content-Type": "application/json",
    },
  }
).then((res) => res.json());

const containers = response.data; //the array of containers 50 - 75 that are still in transit
const pagination = response.pagination; //the pagination object

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 , updated_at
direction - The direction to sort. Available directions are: asc and desc

By default, containers will be sorted by in descending order, meaning the most recently created will be first.

        const response = await fetch("https://api.packagex.io/v1/containers?order_by=created_at&direction=desc", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
}).then((res) => res.json());

const containers = response.data;
const pagination = response.pagination;

Search

There are times when filtering is not enough and you want to find a specific container by some other attribute. In this case, you can do a fuzzy, typo-tolerant search of every container in the database. Below are the properties that are supported by our full text search.

Searchable Properties

metadata._search
tracking_number

To search, simply provide a string to search by using the search query param. The results will be order by the most relevant first. If you want to highlight matching search results for a frontend, we provide a special property for search-returned container objects called _search which will have the matched text surrounded with <mark> handles.

Ordering Search Results

By default, search results are ordered by relevance. However, if you include an order_by parameter along with your search query, the results will be ordered by the specified property instead of by relevance.

Relevance Score

Relevance scores are included in the search results by default. Note that this could add up to 10ms of extra time to the request.

        const response = await fetch("https://api.packagex.io/v1/containers?search=712391239812", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
}).then((res) => res.json());

const container = response.data[0];
console.log(container._search); //Special _search property

Retrieve Container