Update a delivery document

patch

https://api.getbyrd.com/v2/warehouse/delivery-documents/{document_id}

Changes the name or type of the document, or moves it to another
delivery you may access (for a customer, one of their own). Its file
and URL cannot be changed, and customers cannot change its uploader.
Read-only documents cannot be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

document_id

string

required

ID of the delivery document (UUID).

Body Params

deliveryID

string

required

ID of the delivery the document is attached to (UUID). It must be a delivery that has not been deleted and that you may access: for a customer, one of their own deliveries. Any other ID fails with 404, as for a delivery that does not exist. Change it to move the document to another delivery.

name

string

required

File name of the document. Characters other than letters, digits, -, _, (, ) and . are removed.

documentType

string

enum

required

Kind of document. Signed delivery notes are added by the warehouse and are read-only for you.

invoice: invoice
delivery_note: delivery note
signed_delivery_note: delivery note signed on arrival
order: purchase order
packing_list: packing list
customs: customs document
other: any other document

Allowed:

userID

string

required

ID of the user who uploaded the document (UUID). For customers, documents are always recorded as uploaded by them and the uploader cannot be changed: any value they send is ignored.

Responses

200Success response to a valid request

400Generic error response

403Generic error response