1. Scans
  2. Retrieve Scans

Scans

Retrieve Scans

Once you have created scans, you can query for them in the API. If you have the developer or owner role, you're able to also view the scans on your dashboard at https://cloud.packagex.io/dashboard/developers/scans.

Retrieve Scan

GET
`/v1/scans/:scan`

Get a single scan using its id.

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

const scan = response.data;

List Scans

Example

GET
`/v1/scans`

When you want to retrieve multiple scans, your data property on the result will always be an array even if you don't have any scans. The scans are returned in descending order, meaning the latest scan that was created will be first.

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

const scans = 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 scans 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 scans in the database.

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

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

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

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

Filter

You can filter scans by locations for the scans that have a location_id property.

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

const scans = response.data;
const pagination = response.pagination;
Previous <- Create Scans
Next Shipments Overview ->