Order Internal Documents

Upload one or more internal documents for an order

post/orders/{orderId}/internal-documents

Path parameters

orderIdnumber required

Request body

titlestring
notesstring
filesstring[] required

Up to 10 files

Response

Internal document(s) uploaded successfully

idnumber required
orderIdnumber required
fileNamestring required
originalFileNamestring required
filePathstring required
mimeTypestring
fileSizenumber
uploadedBynumber required
titlestring
notesstring
createdAtstring date-time required
updatedAtstring date-time required

Example response

[
  {
    "id": 1,
    "orderId": 1302,
    "fileName": "ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
    "originalFileName": "search-result.pdf",
    "filePath": "https://s3.eu-west-1.amazonaws.com/example-bucket/uploads/internal-documents/ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
    "mimeType": "application/pdf",
    "fileSize": 125845,
    "uploadedBy": 8,
    "uploadedByUser": {
      "id": 8,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com"
    },
    "title": "Registry extract",
    "notes": "Re-check signatures before sharing with ops."
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.