List endpoint for V3 Shipments.

get

https://api.getbyrd.com/v3/shipments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

failed_allocation

boolean

Shipments that failed allocation

user_id

string

ids

array of strings

ids

postal_code

string

date_to

date-time

Shipments created before specific point in time

priority

int32

0 to 50

The priority of the shipment.

total_picks

int32

≥ 1

The total number of unique picks in the shipment.

service

string

enum

Shipments with a specific service level

Allowed:

tracking_number

string

item_count

int32

Shipments with a given number of items

warehouse_user_id

string

products_barcodes_only

boolean

Defaults to false

Filter to only show shipments containing products with barcode.

carrier

array of strings

A list of carrier slugs

carrier

status

array of strings

status

destination_countries

array of strings

destination_countries

failed_packaging

boolean

Shipments that failed packaging (have a label error)

exclude_sub_status

array of strings

exclude_sub_status

sent_date_to

date-time

Shipments sent before specific point in time

total_products

int32

≥ 1

The total number of unique products in the shipment.

date_from

date-time

Shipments created after specific point in time

min_age_days

int32

≥ 1

The minimum age of the shipment in days

failed_release

boolean

Defaults to false

Shipments that failed their last release attempt

product_ids

array of strings

product_ids

string

include_unit_items

boolean

Defaults to false

Filter to show unit items of a shipment.

failed_address_validation

boolean

Shipments that failed address validation

date_field

string

enum

Defaults to created_at

The date field to filter intervals on

Allowed:

sent_date

date

Shipments sent on a specific day

sub_status

array of strings

sub_status

is_b2b

boolean

Show only B2B/B2C shipments

label_error_status

string

enum

Filter shipments by their label error status

Allowed:

v3_packaging

boolean

Filter Shipments that were packed using the v3 API.

byrd_id

string

Shipments with a given byrd ID.

exclude

array of strings

Fields to exclude from the response

exclude

product_id

string

parcel_id

string

Shipments with a unit with given parcel ID

container_code

string

Shipments stored in a given container (prior to packing).

missing_documents

boolean

Select Shipments which are blocked due to missing required documents

warehouse_id

string

total_items

int32

≥ 1

The total number of unique items in the shipment.

priority_range

array of int32s

length ≥ 2

Minimum and maximum priority.

priority_range

order_number

string

The shop order number

error_resolved

boolean

Shipments that have a resolve label error

awaiting_release

boolean

Defaults to false

Shipments that are currently scheduled for release

destination_email

string

The recipient's email address

warehouse_ids

array of strings

warehouse_ids

product_quantities

array of strings

List of the exact contents to filter against (product ID and quantity).

product_quantities

awaiting_allocation

boolean

Defaults to false

Shipments that are currently scheduled for allocation

sent_date_from

date-time

Shipments sent after specific point in time

is_cod

boolean

Show only cash on delivery shipments

per_page

integer

≥ 1

Defaults to 250

Number of results per page

page

integer

≥ 0

Defaults to 0

Result page to jump to, 0-indexed

sort_by

string

The model field to sort results by

sort_order

string

enum

The direction of result sorting

Allowed:

string

The search term

fields

array of strings

Model fields to search through; comma separated

fields

200Success response to a valid request

400Generic error response

403Generic error response