latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Document

endpoint for uploading documents

Use this endpoint to create 1 or multiple document records within our system and use the response to upload the actual files to our secure s3 buckets

post/create-documents

Request body

entitystring

entityIdstring

referenceNumbersstring[]

typestring

namestring

contentTypestring

Example request

[
  {
    "entity": "shipment",
    "entityId": "123455678990",
    "referenceNumbers": [
      "REF_NUMBER"
    ],
    "type": "proof_of_delivery",
    "name": "filename",
    "contentType": "application/json"
  }
]

Response

Status Code 200: Successful Response - the request was successful!

originalFileNamestring

presignedUrlstring

Example response

[
  {
    "originalFileName": "filename",
    "presignedUrl": "https://s3-url.com?key-signed-metadata"
  }
]