Examples

1 Get the unified OTEP timeline

One normalized timeline across self-delivery, third-party and carrier sources.

curl https://api.superroute.ca/api/v1/otep/trackings/SR123456789

{
  "result": true,
  "format": "otep",
  "data": {
    "otep_version": "0.1",
    "profile": "parcel",
    "subject": { "order_id": 12345, "tracking_number": "SR123456789" },
    "current_status": "delivered",
    "delivered": true,
    "events": [
      { "occurred_at": "2026-06-10T08:00:00-04:00", "status_code": "out_for_delivery",
        "phase": "out_for_delivery", "location": { "name": "Toronto Hub" },
        "source": { "type": "self_delivery" } },
      { "occurred_at": "2026-06-10T11:30:00-04:00", "status_code": "delivered",
        "source": { "type": "self_delivery" }, "pod": { "recipient": "J. Smith" } }
    ]
  }
}

2 Project to an external standard

Add ?format= (or an Accept profile) to get the same timeline as GS1 EPCIS 2.0, IATA ONE Record, UN/CEFACT, OpenTelemetry (OTLP), OGC SensorThings, AfterShip, Shopify, Amazon, Walmart, BigCommerce, Magento, WooCommerce or Etsy.

curl "https://api.superroute.ca/api/v1/otep/trackings/SR123456789?format=epcis"

{ "format": "epcis", "data": { "type": "EPCISDocument", "schemaVersion": "2.0",
  "epcisBody": { "eventList": [
    { "type": "ObjectEvent", "action": "OBSERVE", "eventTime": "2026-06-10T11:30:00-04:00",
      "bizStep": "urn:epcglobal:cbv:bizstep:receiving", "disposition": "urn:epcglobal:cbv:disp:received" } ] } } }

curl "https://api.superroute.ca/api/v1/otep/trackings/SR123456789?format=otlp"

3 Verify conformance

POST any timeline to the validator — get back exact errors and warnings against the spec.

curl -X POST https://api.superroute.ca/api/v1/otep/validate \
  -H "Content-Type: application/json" -d '{
    "otep_version":"0.1","profile":"parcel",
    "subject":{"tracking_number":"SR1"},
    "events":[{"status_code":"not_a_code","source":{"type":"bogus"}}]
  }'

{
  "conformant": false,
  "errors": [
    { "path": "events[0].occurred_at", "message": "occurred_at is required (ISO-8601 with offset)" },
    { "path": "events[0].status_code", "message": "unknown status_code 'not_a_code'..." },
    { "path": "events[0].source.type", "message": "source.type must be one of: self_delivery, ..." }
  ],
  "warnings": []
}

4 Map your own status codes onto OTEP

Translate your raw codes to the OTEP codes; keep your native code in source.external_event_code. The complete code list lives in the codebook.

# your code        ->  OTEP status_code
"OFD"            ->  "out_for_delivery"
"DELIVERED"      ->  "delivered"
"ATTEMPT_FAIL"   ->  "delivery_failed"
"RTS"            ->  "return_to_sender"

{ "occurred_at": "2026-06-10T08:00:00-04:00", "status_code": "out_for_delivery",
  "source": { "type": "carrier_label", "carrier_code": "ACME", "external_event_code": "OFD" } }

5 Use it from an AI assistant (MCP)

The public MCP server exposes an otep_tracking tool — an assistant can fetch a timeline (and project it) in natural language.

{ "method": "tools/call",
  "params": { "name": "otep_tracking",
    "arguments": { "tracking_number": "SR123456789", "format": "epcis" } } }

For deeper help, the developer MCP exposes get_otep_guide, and everything (spec, JSON Schema, codebook, MCP config, skill) is available from the protocol home.