GuidesAPI ReferenceChangelog
API Reference

Attach a document to a delivery.

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

The file has to be uploaded beforehand; the document references it
by its URL.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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
enum
required

Format of the file. Cannot be changed after the document is created.

  • pdf
  • jpg
  • jpeg
  • png
  • csv
  • txt
Allowed:
string
required

HTTPS URL of the uploaded file. It must point to byrd's file storage and have no query parameters. Cannot be changed after the document is created.

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