Book a demo consignment

post

/echo

echoConsignment

Takes a consignment and hands it back with an id and a timestamp, exactly as POST /consignments would, except that this one is answered, by this site.

Nothing is stored and nothing is checked beyond the token being present: it exists so the client on the landing page can be pressed.

Authorisation

- bearerhttp · bearer
  A token obtained from the authorisation server.

Request body Required

The consignment to echo.

application/json

object

reference*RequiredstringWhat to call it.
modestringsea | airHow it travels.

json

{
  "reference": "HB-1042",
  "mode": "sea"
}

Responses

201

The consignment, as it would have been stored.

application/json

object

idstring
referencestring
modestringsea | air
createdAtstring

json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "reference": "string",
  "mode": "sea",
  "createdAt": "2026-01-01T09:00:00Z"
}

401

No bearer token was sent.

application/json

objectProblem

title*RequiredstringA short, human-readable summary.
status*Requiredintegermin 400max 599
detailstring | null

json

{
  "title": "string",
  "status": 400,
  "detail": "string"
}

Send a request

curl 'https://api.example.org/v3/consignments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000' \
  -d '{
  "reference": "HB-1042",
  "status": "booked"
}'

Edit this page