Sign in
Document

Retrieves documents for a specified entity

Use this endpoint to retrieve document links and metadata attached to a specific entity.

post/get-documents

Request body

entitystring
entityIdstring
referenceNumbersstring[]
typesstring[]

Example request

{
  "entity": "shipment",
  "entityId": "123455678990",
  "referenceNumbers": [
    "REF_NUMBER"
  ],
  "types": [
    "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"
    }
  ]
}

Changes