Search Package

This operation retrieves a list of packages based on the specified search criteria, such as tracking numbers, status, or associated metadata.

SecuritybearerAuth
Request
query Parameters
startDate
string

Filter package created or updated on or after this date.

Example: startDate=2024-11-27T18:30:00.000Z
endDate
string

Filter assets created or updated on or before this date.

Example: endDate=2024-11-28T18:30:00.000Z
page
integer

The page number of the results to retrieve. Pagination starts from 1.

Example: page=1
size
integer

The number of assets to retrieve per page.

Example: size=25
search
required
string

Search criteria for asset fields such as tracking number. Use fieldName:fieldValue format.

Example: search=trackingNumber:PBKWJAMJYW9ND
searchPosition
string

Specify the position of the search match in the field. Values can include starts or ends.

Example: searchPosition=ends
status
string

Filter assets by status.

Example: status=UNDELIVERED
location
string

Filter packages by location ID. Use the unique identifier of the location.

Example: location=bzxgKm861vv
sort
string

Specify the sorting order of the results. Format: fieldName,DIRECTION. DIRECTION can be ASC or DESC.

Example: sort=insertTimestamp,DESC
secondTierSearchSelected
boolean

Include secondary search criteria for the assets. Defaults to false.

Example: secondTierSearchSelected=false
includeEmptyPackageLocation
boolean

Add assets without a specified package location in the results. Defaults to true.

Example: includeEmptyPackageLocation=true
header Parameters
Content-Type
string
Example: application/json
Responses
200

Requested assets has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/packages
Request samples 
Response samples 
application/json
{
  • "packages": [
    ],
  • "totalCount": 1
}