Count deliveries.

get

https://api.getbyrd.com/v3/deliveries/count

Returns the number of your deliveries that match the filters, which
are the same as for listing deliveries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

include_deleted

boolean

Defaults to false

Whether to include cancelled deliveries. Defaults to false.

include_items

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.

include_containers

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:

user_id

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

type

string

enum

Only deliveries of this type.

container: deliveries arriving in a shipping container
regular: all other deliveries

Allowed:

sku

string

Only deliveries that contain the product with this SKU.

barcode

string

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

first_inbound_only

boolean

Defaults to false

Whether to return only the first delivery inbounded into each warehouse. Defaults to false.

colli_discrepancy

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.

sort_by

string

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

sort_order

string

enum

Sort direction.

asc: ascending
desc: descending

Allowed:

aggregated_container_status

string | null

enum

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

date_field

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_from

date-time

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

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

string

The search term

fields

array of strings

Model fields to search through; comma separated

fields

Responses

200Success response to a valid request

400Generic error response

403Generic error response