GuidesAPI ReferenceChangelog
API Reference

Schedule the pickup of a B2B shipment.

post
https://api.getbyrd.com/v3/shipments//schedule-pickup

Sets the days a packed B2B shipment will be collected and, if known,
the carrier and its tracking data, or that you collect it yourself.
Allowed while the shipment's sub-status is pickup_details_required,
pickup_details_uploaded or label_required.

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

Whether you collect the shipment from the warehouse yourself instead of a carrier; defaults to false.

string | null

Name of the carrier collecting the shipment; null if not known.

url | null

Tracking URL from the carrier collecting the shipment; null if there is none.

string | null

Tracking number from the carrier collecting the shipment; null if there is none.

date
required

First day the shipment can be collected (ISO 8601); today or later.

date
required

Last day the shipment can be collected (ISO 8601); today or later, and also used as the planned sent date.

Responses
200

Empty response content

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