Happy Path in 5 Calls¶

This page shows the most common integration loop using one item flow.

1) Connectivity check¶

Request:

GET /status

Expected:

200 with service status payload

2) Receive next sortation message¶

Request:

GET /sortation?timeOut=10

Expected:

210 with REQUEST DTO
212 with VERIFY DTO
204 when no message is currently available

3) Respond to REQUEST with assignment¶

When step 2 returns 210 (REQUEST), send assignment:

POST /sortation
Content-Type: application/json

{
  "TrackID": "00.329.000092727",
  "Destination": "DST-CH-0012-1-B",
  "Barcode": "B000121238776"
}

Expected:

200 with ack body

4) Receive destination SCAN events¶

Request:

GET /destination?timeOut=10

Expected:

211 with SCAN DTO
204 when no message is currently available

5) Send destination status updates¶

Request:

POST /destination
Content-Type: application/json

{
  "Destination": "DST-CH-0012-1-B",
  "DestinationStatus": "NotReady",
  "DestinationText": "SORT",
  "LightStatus": "Solid",
  "LightColor": "BLUE"
}

Expected:

200 with ack body

Notes¶

Queue-empty behavior is 204 No Content (no EMPTY payload object).
Non-standard success codes are intentionally used: 210, 211, 212.
For POST /destination enum fields, parsing is case-insensitive.