Get shipment document by id

Get a specific shipment document. When getting shipment, first level sub-object will be retrieved that will include document(s) which offer an alternative way of getting it(them).

A shipment document will not contain the physical file (e.g. the pdf, jpg,…), only its metadata. The file can be downloaded using the value of the signedUrl attribute.

Get shipment document by id

get

Get shipment document by id

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

400

Bad Request

application/json

401

Unauthorized Entity

application/json

422

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /shipment-document/{id} HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "filePath": "text",
  "signedUrl": "text",
  "name": "text",
  "createdAt": null,
  "updatedAt": null
}