Get all shipment detail

The /shipment-detail route can be used to retrieve all the details 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 details for a specific shipment.

---

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.

• quantity - to filter by the quantity.

• quantityType - to filter by the type of quantity.

• dangerousClass - to filter by the dangerous class.

• unClassification - to filter by the UN classification.

• addtionalReference - to filter by the additional reference.

• createdAt - to filter by the creation date

---

Get all shipment details

get

Get all shipment details

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

400

Bad Request

application/json

401

Unauthorized Entity

application/json

422

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /shipment-detail 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",
      "goodsDescription": "text",
      "quantity": 1,
      "quantityType": "text",
      "weight": 1,
      "width": 1,
      "height": 1,
      "length": 1,
      "support": "text",
      "location": "text",
      "volume": 1,
      "dangerousClass": "text",
      "unClassification": "text",
      "additionalReference": "text",
      "serialNumber": "text",
      "ecv": "text",
      "icv": "text",
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}