GuidesAPI ReferenceChangelog
API Reference

List deliveries

get
https://api.getbyrd.com/v2/warehouse/deliveries

Returns your deliveries, the inbound shipments of stock you send to a
warehouse, with their items, containers and metrics. Filter them with
the query parameters and use only to return fewer fields. See
Listing deliveries.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Whether to include cancelled deliveries. Defaults to false.

boolean
Defaults to true

Whether to include deliveryItems in each delivery. Defaults to true; set it to false for faster responses when deliveries have many items.

boolean
Defaults to true

Whether to include deliveryContainers in each delivery. Defaults to true.

product_ids
array of uuids

Only deliveries that contain at least one of these products (UUIDs).

product_ids
warehouse_ids
array of uuids

Only deliveries to these warehouses (UUIDs).

warehouse_ids
status
array of strings

Only deliveries in one of these statuses (see status).

status
Allowed:
uuid

Only deliveries of this user (UUID). Cannot be combined with user_ids. You only ever see your own deliveries.

user_ids
array of uuids

Only deliveries of these users (UUIDs). Cannot be combined with user_id. You only ever see your own deliveries.

user_ids
string
enum

Only deliveries of this type.

  • container: deliveries arriving in a shipping container
  • regular: all other deliveries
Allowed:
string

Only deliveries that contain the product with this SKU.

string

Only deliveries that contain a product with this barcode, either its main barcode or one of its additional barcodes.

boolean
Defaults to false

Whether to return only the first delivery inbounded into each warehouse, per customer. Deliveries that were never inbounded are left out; deliveries inbounded at the same earliest time are all returned. Defaults to false.

boolean
Defaults to false

Whether to return only deliveries where the number of boxes and pallets counted on arrival differs from the number of containers announced. Defaults to false.

string

Field to sort the deliveries by: createdAt, updatedAt, expectedDeliveryDateFrom, atWarehouseDateTime, inProcessingDateTime, inboundedDateTime, inboundingDeadline or aggregatedContainerStatus.

string
enum

Sort direction.

  • asc: ascending
  • desc: descending
Allowed:
string | null
enum

Only deliveries with this tracking status (see aggregatedContainerStatus). pick_up also matches deliveries that are not tracked.

string
enum
Defaults to created_at

Date field that date_from and date_to filter on. Defaults to created_at.

  • created_at: when the delivery was announced
  • at_warehouse_at: when the warehouse accepted it
  • inbounded_at: when it was completed
  • status_updated_at: when its status last changed
Allowed:
date-time

Only deliveries whose date_field is at or after this time (ISO 8601, UTC). Must be before date_to.

date-time

Only deliveries whose date_field is before this time (ISO 8601, UTC).

only
array of strings

Fields to return, as comma-separated dotted paths, for example id,status,deliveryItems.product.sku. All fields are returned when omitted.

only
integer
≥ 1
Defaults to 250

Number of results per page

integer
≥ 0
Defaults to 0

Result page to jump to, 0-indexed

string

The search term

fields
array of strings

Model fields to search through; comma separated

fields
Headers
string
enum
Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:
Responses

Updated 4 days ago

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

Updated 4 days ago