GuidesAPI ReferenceChangelog
API Reference

Update a delivery

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

Changes only the fields you send and returns them. As a customer,
you can change a delivery only while it is announced, except for
its customs declaration: customsMRN, isInternational,
senderName and senderAddress. The customs MRN can only be set
while the delivery is announced or atWarehouse, and an
international delivery cannot be made domestic once it has arrived.
To change the items or containers, replace the delivery with a full
update.

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

ID of the delivery (UUID).

Body Params
string | null
^[0-9]{2}GB[A-Z0-9]{14}\Z

UK customs Movement Reference Number (MRN) of the goods: 18 characters, two digits for the year, GB, then 14 uppercase letters or digits. Only allowed for deliveries to a warehouse in the United Kingdom; you can set it while the delivery is announced or atWarehouse, including with a partial update after arrival. null when not provided.

string | null

Free-text summary of the contents of the delivery; null when not provided.

date-time
required

Start of the window in which the delivery is expected to arrive at the warehouse (ISO 8601, UTC). For container deliveries it must equal expectedDeliveryDateTo. Customers can only change it while the delivery is announced.

date-time
required

End of the window in which the delivery is expected to arrive at the warehouse (ISO 8601, UTC). For container deliveries it must be a business day at least 10 business days from now. Customers can only change it while the delivery is announced.

boolean
required

Whether express inbounding is requested. Always send false.

boolean | null

Whether the goods cross a border into the warehouse's country. Only for deliveries to a warehouse in the United Kingdom, where it is required when announcing or fully updating the delivery. When true, senderName and senderAddress are required and the warehouse cannot inbound the delivery until customsMRN is provided. Customers can still declare it true with a partial update after the delivery has left announced, but not change it back once the goods have arrived. null when it does not apply.

string | null

Your own reference for the delivery, such as a purchase order number; null when not provided.

boolean | null

Whether the warehouse counts every item on arrival; charges may apply. When false, stock is booked as announced and byrd is not liable for discrepancies. Defaults to true; cannot be true together with requiresSampling. Customers can only change it while the delivery is announced.

boolean | null

Whether the warehouse checks a representative sample of the goods on arrival instead of counting every item. Defaults to false; cannot be true together with requiresCounting. Customers can only change it while the delivery is announced.

string | null

Address the delivery is sent from; required for international deliveries, otherwise null when not provided. Part of the customs declaration, so customers can still change it with a partial update after the delivery has left announced.

string | null

Name of the sender of the delivery; required for international deliveries, otherwise null when not provided. Part of the customs declaration, so customers can still change it with a partial update after the delivery has left announced.

boolean
required

Always send true.

boolean | null
string | null
enum

Size of the shipping container, as you announced it. Only for container deliveries; null otherwise.

  • 20ft: 20-foot container
  • 40ft: 40-foot container
Allowed:
boolean | null

Whether the goods in the shipping container are on pallets, as you announced it. Only for container deliveries; null otherwise.

uuid
required

ID of the warehouse receiving the delivery (UUID).

string
enum
Defaults to regular

Type of delivery. Defaults to regular.

  • container: arriving in a shipping container; the expected dates must be equal, a business day, and at least 10 business days from now
  • regular: every other delivery
  • unknown: type not recorded
Allowed:
Headers
string
enum
Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:
Responses

Updated about 1 month 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 about 1 month ago