Announce a delivery

post

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

Tells the warehouse what stock to expect, so the goods can be received
against the delivery on arrival. Send the products in deliveryItems
and the parcels or pallets in deliveryContainers; the delivery
starts as announced. Print the delivery note and attach it to every
parcel or pallet. See
Announcing a delivery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customsMRN

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.

description

string | null

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

expectedDeliveryDateFrom

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.

expectedDeliveryDateTo

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.

expressInbounding

boolean

required

Whether express inbounding is requested. Always send false.

isInternational

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.

referenceNumber

string | null

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

requiresCounting

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.

requiresSampling

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.

senderAddress

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.

senderName

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.

stocktaking

boolean

required

Always send true.

unmixedDelivery

boolean | null

containerSizeAnnounced

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:

isPalletizedAnnounced

boolean | null

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

deliveryContainers

array of objects

required

length ≥ 1

Parcels or pallets the delivery arrives in, one per tracking number; at least one is required when announcing. A full update replaces them all.

deliveryContainers*

sequenceNumber

integer

required

≥ 0

Position of the container within the delivery, used to order the containers; 0 or greater.

type

string

enum

required

How the container arrives. Use the same type for all containers of a delivery.

parcel: a parcel
pallet: a pallet
euroPallet: a EUR-pallet (Euro-pallet)

Allowed:

exchangeablePallet

boolean

required

Whether the delivery is on exchangeable EUR-pallets (Euro-pallets, EPAL), which the warehouse exchanges for empty ones with the carrier on arrival. Set it to false when the pallet type is unknown or different.

carrier

string

enum

required

Carrier bringing the container to the warehouse. Use unknown for any carrier not listed and give its name in unknownCarrierName.

unknownCarrierName

string | null

required

Name of the carrier when carrier is unknown; an empty string or null otherwise.

trackingNumber

string | null

required

Tracking number of the container with its carrier, used to track it on its way to the warehouse; null when there is none. Must not be a URL.

trackingURL

string | null

required

URL where the container can be tracked; null or empty when there is none.

arrived

boolean

Whether the container has arrived at the warehouse, as recorded by the warehouse.

warehouseID

uuid

required

ID of the warehouse receiving the delivery (UUID).

type

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:

deliveryItems

array of objects

required

length ≥ 1

Products in the delivery and their announced amounts; at least one is required when announcing, and each product may appear only once. A full update replaces them all.

deliveryItems*

sequenceNumber

integer

required

≥ 0

Position of the item within the delivery, used to order the items; 0 or greater.

amount

integer

required

≥ 1

Number of units of the product announced in the delivery; at least 1.

boxcode

string

required

Your identifier of the box or boxes the product arrives in. Separate several box codes with commas.

productID

uuid

required

ID of the product announced in this item (UUID). The product must be active and cannot be a bundle or an alias.

inboundingDeadline

object

Date by which the warehouse is due to inbound the delivery, and how that date was set. Calculated by byrd; ignored when sent.

documents

array of objects

Documents to attach to the delivery when announcing it, such as invoices or packing lists. Upload the files first.

documents

201Success response to a valid request

400Generic error response

403Generic error response