GET
/
delivery
List deliverys
curl --request GET \
  --url http://localhost:8080/delivery \
  --header 'x-api-key: <api-key>'
[
  {
    "code": "<string>",
    "shipment": {
      "value": "550e8400-e29b-41d4-a716-446655440000",
      "label": "SHIP-001"
    },
    "carrier": {
      "value": "550e8400-e29b-41d4-a716-446655440001",
      "label": "DHL Express"
    },
    "receiver": {
      "value": "550e8400-e29b-41d4-a716-446655440002",
      "label": "Customer Inc."
    },
    "route_code": "<string>",
    "route_name": "<string>",
    "transport_mode": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "site_id": "<string>"
  }
]

Authorizations

x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Query Parameters

Search term to filter results

page
integer

Page number for pagination

Required range: x >= 1
pageSize
integer

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved deliverys

The response is of type object[].