Get all shipment

About

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

---

Groups

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

List of groups

• departureCountry - to retrieve information about the departure country.

• arrivalCountry - to retrieve information about the arrival country.

• departure - to retrieve information about the departure.

• arrival - to retrieve information about the arrival.

• anomalies - to retrieve information about shipment anomalies.

• anomalies.category - to retrieve information about the category of anomalies.

• anomalies.type - to retrieve information about the type of anomalies.

• assignations - to retrieve information about shipment assignations.

• assignations.user - to retrieve information about the user associated with assignations.

• customs - to retrieve information about shipment customs.

• customs.type - to retrieve information about the type of customs.

• details - to retrieve information about shipment details.

• documents - to retrieve information about documents.

• events - to retrieve information about shipment events.

• events.type - to retrieve information about the type of events.

• operators - to retrieve information about shipment operators.

• operators.comments - to retrieve information about comments from operators.

• securities - to retrieve information about shipment securities.

• services - to retrieve information about shipment services.

• services.type - to retrieve information about the type of services.

• preparations - to retrieve information about shipment preparations.

• preparations.shipment - to retrieve information about shipment preparation details.

• preparations.master - to retrieve information about master preparation details.

Filters

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

List of filters

• shipmentId - to filter by the shipment ID.

• orderReference - to filter by the order reference.

• departure.code - to filter by the departure code.

• arrival.code - to filter by the arrival code.

• departureCountry.code - to filter by the departure country code.

• arrivalCountry.code - to filter by the arrival country code.

• customerReference - to filter by the customer reference.

• isDangerous - to check if the shipment is dangerous.

• isSecure - to check if the shipment is secure.

• mawbNumber - to filter by the MAWB (Master Air Waybill) number.

• limitBoardingTime - to filter by the time limit for boarding.

• events.type - to filter by the type of events.

• events.eta - to filter by the estimated time of arrival (ETA) for events.

• customs - to filter by shipment customs.

• customs.type - to filter by the type of customs

• operators.code - to filter by the operator's code.

• operators.name - to filter by the operator's name.

• operators.society - to filter by the operator's society.

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

• assignations.user - to filter by the user assigned to the shipment.

• assignations - to filter by shipment assignations.

  • ne - true

  • is - true

• anomalies - to filter by shipment anomalies.

  • ne - true

  • is - true

• anomalies.type - to filter by the type of anomalies.

• anomalies.category - to filter by the category of anomalies.

  • ne - true

  • is - true

• departure - to filter by the departure.

  • ne - true

  • is - true

• arrival - to filter by the arrival.

  • ne - true

  • is - true

• departureCountry - to filter by the departure country.

  • ne - true

  • is - true

• arrivalCountry - to filter by the arrival country.

  • ne - true

  • is - true

• preparations - to filter by shipment preparations.

• preparations.shipment - to filter by shipment preparation details.

• preparations.master - to filter by master preparation details.

---

Endpoints

Get all shipments

get

Retrieve all shipments

Authorizations

Query parameters

page[cursor]stringOptional

page[limit]any · min: 2 · max: 200Optional

order[column]stringOptionalExample: column_name

order[direction]stringOptionalExample: asc|desc

Responses

get

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
      "departure": "text",
      "departureCountry": "AD",
      "arrival": "text",
      "arrivalCountry": "AD",
      "orderReference": "text",
      "customerReference": "text",
      "quantityExpected": 1,
      "quantityTypeExpected": "AUT",
      "grossWeightExpected": 1,
      "grossWeightTaxableExpected": 1,
      "volumeExpected": 1,
      "quantityReal": 1,
      "quantityTypeReal": "AUT",
      "grossWeightReal": 1,
      "grossWeightTaxableReal": 1,
      "volumeReal": 1,
      "mawbNumber": "text",
      "hawbNumber": "text",
      "hbl": "text",
      "mbl": "text",
      "goodsDescription": "text",
      "fly": "text",
      "ship": "text",
      "isSecure": true,
      "isDangerous": true,
      "limitBoardingTime": "text",
      "shippingReference": "text",
      "assignations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "anomalies": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "customs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "details": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "documents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "events": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "operators": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "securities": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "services": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "preparations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}