GuidesAPI ReferenceChangelog
API Reference

List units.

get
https://api.getbyrd.com/v3/units

Returns the units (parcels and pallets) of your shipments, newest
first by default, one page at a time. Filter by shipment_id to page
through the units of a shipment that has too many to read from the
shipment itself.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of uuids

Only return these units, by ID (comma-separated).

ids
shipment_id
array of uuids

Only return units of these shipments, by ID (comma-separated). Use it to page through the units of a shipment with many units.

shipment_id
string
length between 1 and 10

Only return the unit with this parcel ID.

status
array of strings

Only return units with one of these statuses (comma-separated).

status
Allowed:
sub_status
array of strings

Only return units with one of these sub-statuses (comma-separated). Requires status, and each sub-status must be possible for at least one of the given statuses.

sub_status
boolean

Whether to leave out units blocked by an error of a SLAM machine.

label_error_status
array of strings

Only return units whose label error has one of these triage statuses (comma-separated); untriaged selects label errors not looked at yet. See label_error_status in the response for the values.

label_error_status
string

Only return units at least this old, measured from their creation: a positive whole number followed by h (hours), d (days), w (weeks) or m (30 days), for example 2d.

string

Only return units at most this old. Same format as min_age.

boolean

Only return units whose shipment is (true) or is not (false) custom-handled.

boolean

Only return units whose shipment belongs (true) or does not belong (false) to a demo account.

user_id
array of uuids

Only return units of shipments of these byrd accounts, by ID (comma-separated). For customers, always their own account.

user_id
warehouse_id
array of uuids

Only return units of shipments fulfilled by these warehouses, by ID (comma-separated).

warehouse_id
string

Field to sort by. Defaults to created_at.

  • created_at
  • updated_at
  • label_error_occurred
string
enum

Sort direction, asc or desc. Defaults to desc.

Allowed:
boolean
Defaults to false

Whether to include deleted units. Defaults to false; always false for customers.

only
array of strings

Comma-separated dotted paths of the fields to return, for example id,status,items.

only
integer
≥ 1
Defaults to 250

Number of results per page

integer
≥ 0
Defaults to 0

Result page to jump to, 0-indexed

Responses

Updated 1 day ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago