Exemplos

Exemplos prontos para copiar e colar para construir e verificar uma integração OTEP. Todos os endpoints são públicos e somente leitura.

1 Obter a linha do tempo OTEP unificada

Uma linha do tempo normalizada entre entrega própria, terceiros e transportadoras.

GET pedido

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

resposta

{
  "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 Projetar para um padrão externo

Adicione ?format= (ou um perfil Accept) para obter a mesma linha do tempo como GS1 EPCIS 2.0, IATA ONE Record, UN/CEFACT, OpenTelemetry (OTLP), OGC SensorThings, AfterShip, Shopify, Amazon, Walmart, BigCommerce, Magento, WooCommerce ou 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 (uma remessa = um trace, cada evento = um span)

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

3 Verificar a conformidade

Envie qualquer linha do tempo via POST ao validador e receba os erros e avisos exatos em relação à especificação.

POST pedido

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"}}]
  }'

resposta

{
  "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 Mapear os seus próprios códigos de estado para OTEP

Traduza os seus códigos brutos para os códigos OTEP; mantenha o seu código nativo em source.external_event_code. A lista completa de códigos está no Codebook.

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

evento resultante

{ "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 Usar a partir de um assistente de IA (MCP)

O servidor MCP público expõe uma ferramenta otep_tracking — um assistente pode obter uma linha do tempo (e projetá-la) em linguagem natural.

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

Para ajuda mais aprofundada, o MCP para programadores expõe get_otep_guide, e tudo (especificação, JSON Schema, Codebook, configuração MCP, skill) está disponível a partir do início do protocolo.