Lots

Retrieve Lot

GET

`/v1/lots/:lot`

Get a single lot using its id.

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

const lot = response.data;

List Lots

Example

GET

`/v1/lots`

When you want to retrieve multiple lots, your data property on the result will always be an array even if you don't have any lots.

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

const lots = response.data; //the array of lots
const pagination = response.pagination; //the pagination object

Pagination

If the has_more property on the pagination object is set to true, you know there are more lots 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 lots in the database.

By default the page is set to 1 and the limit is 25.

If we want to query for lots 26 - 50, we would request page 2 with a query parameter.

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

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

Filter

You can filter lots by location_id, item_id, layout_id, statuses and metadata. You can also filter with date ranges for created_at, updated_at and expires_at.

location_id - Add the ID of one of your locations to get all of the lots currently mapped to that location. For example: location_id=loc_czhgjrk5JaVvyATPDbyURp

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

const lots = response.data;
const pagination = response.pagination;

item_id - Add the id of the asset item to get all of the lots created against the item. For example: item_id=item_czhgjrk5JaVvyATPDbyURp

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

const lots = response.data;
const pagination = response.pagination;

layout_id - Add the id of the layout to get all lots currently mapped to that layout. For example: layout_id=layout_czhgjrk5JaVvyATPDbyURp

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

const lots = response.data;
const pagination = response.pagination;

statuses - Allows you to filter lots that have a given status. You can pass comma separated list of statuses to filter with

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

const lots = response.data;
const pagination = response.pagination;

date filters - You can pass one or more date filters such as created_at_gte, updated_at_gte, expires_at_gte, as well as created_at_lte, updated_at_lte and expires_at_lte to filter lots in the specified date range. For example

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

const lots = response.data;
const pagination = response.pagination;

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

By default, lots will be sorted by in ascending order by name, meaning they are returned alphabetically.

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

const lots = response.data;
const pagination = response.pagination;

Search

There are times when filtering is not enough and you want to find a specific asset by some other attribute, for example by name, SKU, or GTIN, vendor, and serial number. In this case, you can do a fuzzy, typo-tolerant search of every asset in the database.

Searchable Properties

manufacturer_number
number
sku

To search, simply provide a string to search by using the search query param. If you want to highlight matching search results for a frontend, we provide a special property for search-returned lot 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/lots?search=coffee", {
  method: "GET",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
}).then((res) => res.json());

const asset = response.data[0];

Retrieve Lot

# List Lots

# Example

# Pagination

# Filter

# Sorting