Get all shipment customs

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

• type - retrieve information about the type

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.

• type.name - to filter by the type name.

• status - to filter by the status.

• date - to filter by the date.

• number - to filter by the number.

• createdAt - to filter by the creation date

---

Get all shipment customs

get

Get all shipment customs

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/shipment-customs

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "shipment": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "status": "text",
      "number": "text",
      "date": null,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}