Get all shipment security

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.

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

• type - to filter by the type.

• agent - to filter by the agent.

• quantity - to filter by the quantity.

• position - to filter by the position.

• securedAt - to filter by the secured at date.

• createdAt - to filter by the creation date.

---

Get all shipment securities

get

Get all shipment securities

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-security 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",
      "type": "text",
      "agent": "text",
      "quantity": 1,
      "status": "text",
      "position": "text",
      "securedAt": null,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}