Get all shipment operator

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

  • society - retrieve information about the society

  • country - retrieve information about the country

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.

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

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

  • name - to filter by the name.

  • code - to filter by the code.

  • agreementNumber - to filter by the agreement number.

  • createdAt - to filter by the creation date

Get a list of shipment operators

get

Get a list of shipment operators

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-operator 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",
      "society": "text",
      "country": "AD",
      "code": "CONSIGNEE",
      "address": "text",
      "addressComplementary": "text",
      "postalCode": "text",
      "city": "text",
      "name": "text",
      "contact": "text",
      "email": "[email protected]",
      "tel": "text",
      "fax": "text",
      "phone": "text",
      "agreementNumber": "text",
      "agreementValidity": null,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}
PreviousShipment OperatorNextGet shipment operator by id

Last updated