Get all shipment service

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.id - to filter by the type ID.

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

  • isDone - to filter by whether the task or process is done.

  • createdAt - to filter by the creation da


Get a collection of shipment services

get

Get a collection of shipment services

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-service 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": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "isDone": true,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}

Last updated