Przykłady

Gotowe do skopiowania przykłady budowania i weryfikowania integracji OTEP. Wszystkie punkty końcowe są publiczne i tylko do odczytu.

1 Pobierz ujednoliconą oś czasu OTEP

Jedna znormalizowana oś czasu obejmująca dostawę własną, podmioty zewnętrzne i przewoźników.

GET żądanie

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

odpowiedź

{
  "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 Rzutuj na standard zewnętrzny

Dodaj ?format= (lub profil Accept), aby uzyskać tę samą oś czasu jako GS1 EPCIS 2.0, IATA ONE Record, UN/CEFACT, OpenTelemetry (OTLP), OGC SensorThings, AfterShip, Shopify, Amazon, Walmart, BigCommerce, Magento, WooCommerce lub 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 (przesyłka = jeden trace, każde zdarzenie = jeden span)

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

3 Zweryfikuj zgodność

Wyślij dowolną oś czasu metodą POST do walidatora i otrzymaj dokładne błędy i ostrzeżenia względem specyfikacji.

POST żądanie

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

odpowiedź

{
  "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 Zmapuj własne kody statusów na OTEP

Przetłumacz swoje surowe kody na kody OTEP; zachowaj swój natywny kod w source.external_event_code. Pełna lista kodów znajduje się w Codebook.

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

zdarzenie wynikowe

{ "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 Użyj z asystenta AI (MCP)

Publiczny serwer MCP udostępnia narzędzie otep_tracking — asystent może pobrać oś czasu (i ją rzutować) w języku naturalnym.

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

Aby uzyskać bardziej szczegółową pomoc, deweloperski MCP udostępnia get_otep_guide, a wszystko (specyfikacja, JSON Schema, Codebook, konfiguracja MCP, skill) jest dostępne na stronie głównej protokołu.