Sign in
latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Document

Retrive document on a specified entity

Use this endpoint to retrive document links and metadata attached to specific entities

post/get-documents

Request body

entitystring
entityIdstring
referenceNumbersstring[]
typestring

Example request

{
  "entity": "shipment",
  "entityId": "123455678990",
  "referenceNumbers": [
    "REF_NUMBER"
  ],
  "type": "proof_of_delivery"
}

Response

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

countnumber

Example response

{
  "count": 5,
  "documents": [
    {
      "name": "Proof of Delivery",
      "createdAt": "2023-09-20T03:02:32.359Z",
      "signedUrl": "https://s3-url-link-to-file.com/bucket?metadata-info",
      "type": "proof_of_delivery",
      "status": "UPLOADED"
    }
  ]
}