Sendle · OpenAPI Overlay 1.0.0

Sendle Tracking API — API Evangelist Overlay

API Evangelist enhancements over openapi/sendle-tracking-api-openapi.yml. This overlay never mutates the original: it records the retirement of the API, corrects the info.title that the tag-split step overwrote, and attaches the runtime semantics (idempotency, reversibility, rate limits, error format, pagination) that the contract itself leaves undeclared. Every value is grounded in the captured spec or in a probe recorded in this repository.

5 actions 5 updates update extends openapi/sendle-tracking-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sendle's API. It is a proposal applied on top of the contract, not a document Sendle publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

titlex-lifecycle-statex-retired-onx-retirement-notex-host-resolvesx-probedx-probe-resultx-apievangelist-artifacts

Targets 4

$.info

$.servers[*]

$.paths['/parcels/{ref}/tracking'].get

$.paths['/parcels/{ref}/tracking/subscribe'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: Sendle Tracking API — API Evangelist Overlay
  version: 1.0.0
  description: 'API Evangelist enhancements over openapi/sendle-tracking-api-openapi.yml. This overlay
    never mutates the original: it records the retirement of the API, corrects the info.title that the
    tag-split step overwrote, and attaches the runtime semantics (idempotency, reversibility, rate limits,
    error format, pagination) that the contract itself leaves undeclared. Every value is grounded in the
    captured spec or in a probe recorded in this repository.'
extends: openapi/sendle-tracking-api-openapi.yml
x-generated: '2026-08-26'
x-method: generated
actions:
- target: $.info
  description: Correct the title, which the tag-split step overwrote with the manifests title, and mark
    the contract retired.
  update:
    title: Sendle Tracking API
    x-lifecycle-state: retired
    x-retired-on: '2026-01-11'
    x-retirement-note: RETIRED — this API can no longer be called. Sendle ceased operations on 2026-01-11
      and the company entered liquidation; api.sendle.com and sandbox.sendle.com were withdrawn from DNS
      and returned NXDOMAIN when probed on 2026-08-26 against four independent resolvers and the sendle.com
      authoritative nameserver. This overlay marks the contract as archival so no tooling generates an
      integration against it.
- target: $.servers[*]
  description: Record that every declared server host no longer resolves.
  update:
    x-host-resolves: false
    x-probed: '2026-08-26'
    x-probe-result: NXDOMAIN
- target: $.info
  description: Point at the API Evangelist artifacts that carry the runtime semantics this contract does
    not declare.
  update:
    x-apievangelist-artifacts:
      conventions: conventions/sendle-conventions.yml
      errors: errors/sendle-problem-types.yml
      lifecycle: lifecycle/sendle-lifecycle.yml
      data-model: data-model/sendle-data-model.yml
      conformance: conformance/sendle-conformance.yml
      authentication: authentication/sendle-authentication.yml
      rate-limits: rate-limits/sendle-rate-limits.yml
- target: $.paths['/parcels/{ref}/tracking'].get
  description: Surface the one published numeric rate limit, which lived only in prose.
  update:
    x-rate-limit: 10 requests/second per IP
    x-rate-limit-headers: none declared
    x-recommended-polling: at most once per hour per parcel
- target: $.paths['/parcels/{ref}/tracking/subscribe'].post
  description: Record that the 422 here is a dashboard configuration failure an API client cannot remediate.
  update:
    x-callback-url-configured-out-of-band: true
    x-422-meaning: No account-level callback URL is configured; it can only be set in the Sendle dashboard.
    x-webhook-signature: none declared