Get all shipment document

The /shipment-document route can be used to retrieve all the documents attached to shipments that belong to the user society. As the amount of data can be big, a pagination system is used. In order to get more relevant results, it is possible to filter and sort data, e.g. to get document for a specific shipment.

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.

Groups

To understand the groups parameter and the customization of API responses, please refer to the groups page.

List of groups

  • shipment - retrieve information about the shipment

Filters

To understand the filters parameter and the customization of API responses, please refer to the filters page.

List of filters

  • id - to filter by the unique identifier.

  • shipment.shipmentId - to filter by the shipment ID.

  • shipment.orderReference - to filter by the order reference of the shipment.

  • shipment.createdAt - to filter by the creation date of the shipment.

  • name - to filter by the name.

  • createdAt - to filter by the creation date.

Get all shipment documents

get

Get all shipment documents

Authorizations
Query parameters
page[cursor]stringOptional
page[limit]any · min: 2 · max: 200Optional
order[column]stringOptionalExample: column_name
order[direction]stringOptionalExample: asc|desc
Responses
200Success
application/json
get
GET /shipment-document HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "shipment": "123e4567-e89b-12d3-a456-426614174000",
      "filePath": "text",
      "signedUrl": "text",
      "name": "text",
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}
PreviousShipment DocumentNextGet shipment document by id

Last updated