示例

用于构建和验证 OTEP 集成的、可直接复制粘贴的示例。所有端点均为公开只读。

1 获取统一的 OTEP 时间线

跨自配送、第三方与承运商的一条标准化时间线。

GET 请求

curl https://api.superlabel.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 投影到外部标准

加上 ?format=（或 Accept profile）即可把同一条时间线转换为 GS1 EPCIS 2.0、IATA ONE Record、UN/CEFACT、OpenTelemetry (OTLP)、OGC SensorThings、AfterShip、Shopify、Amazon、Walmart、BigCommerce、Magento、WooCommerce 或 Etsy。

GET EPCIS

curl "https://api.superlabel.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" } ] } } }

GET OpenTelemetry（一个货件 = 一条 trace，每个事件 = 一个 span）

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

3 校验合规性

向校验器 POST 任意时间线，即可得到针对规范的精确错误与警告。

POST 请求

curl -X POST https://api.superlabel.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 把你自己的状态码映射到 OTEP

把你的原始码翻译为 OTEP 码；并在 source.external_event_code 中保留你的原生码。完整码表见 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 通过 AI 助手使用（MCP）

公共 MCP 服务提供 otep_tracking 工具——助手可用自然语言获取时间线（并投影）。

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

如需更深入的帮助，开发者 MCP 提供 get_otep_guide，且所有内容（规范、JSON Schema、Codebook、MCP 配置、skill）都可在协议主页获取。