GuidesAPI ReferenceChangelog
API Reference

Get a shipment

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

Returns the details of one of your shipments, including its parcels
(units) with their tracking data and the items packed in each. Use
only to return just the fields you need.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the shipment (UUID).

Query Params
only
array of strings

Fields to return, as comma-separated dotted paths of response field names, for example id,status,units.items; all fields when not sent.

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

Generated from available response content types

Allowed:
Responses

Updated 5 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 5 days ago