GuidesAPI ReferenceChangelog
API Reference

Download a shipment report.

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

Returns a CSV file with one row per item in each parcel of your
shipments in the given period, most recent first and up to 10000
rows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required

Start of the period to report on (ISO 8601); must be before date_to and not in the future.

date-time
required

End of the period to report on (ISO 8601, inclusive); must not be in the future.

string

Only parcels sent with this carrier, by carrier slug.

string
enum
Defaults to packaged_at

Date that date_from and date_to apply to; defaults to packaged_at.

  • packaged_at: parcel packed
  • sent_at: parcel handed over to the carrier
  • returned_at: shipment returned
  • created_at: shipment created
Allowed:
uuid

Only parcels from this warehouse (UUID).

uuid

ID of the byrd account to report on (UUID); if you send it, it has to be your own account.

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