GuidesAPI ReferenceChangelog
API Reference

Update a delivery document.

patch
https://api.getbyrd.com/v2/warehouse/delivery-documents/

Changes the name or type of the document; its file and URL cannot be
changed. Read-only documents cannot be updated.

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

ID of the delivery the document is attached to (UUID).

string
required

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

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:
string
required

ID of the user who uploaded the document (UUID).

Responses

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