# Changelog All notable changes to the FleetBridge Order Source API contract and this documentation package are recorded here. ## 1.1.0 — revision 2026-10-10 - Additive: optional Create Order field `externalOrderNumber` (string, ≤200), your human-readable order number. FleetBridge shows it to operators and sends it to the Delivery Provider as its visible order reference. It is display only: never a correlation, lookup, de-dup, or idempotency key. Omitted or blank falls back to `externalOrderId`; it cannot be updated. - `externalOrderNumber` is returned by Create, `GET /orders/{platformOrderId}`, and `GET /orders/by-external-id/{externalOrderId}`, falling back to `externalOrderId` for orders created without one. Webhook payloads are unchanged. - `externalOrderId` is now described explicitly as the technical identifier. ## 1.0.0 — revision 2026-09-22 - Initial publication of the standalone Order Source Integration Kit, covering: - Authentication (`X-Api-Key`) and error model. - Create, Update, Cancel, and all read endpoints (`GetById`, `GetByExternalId`, `GetStatus`, `GetTracking`, `GetTrackingHistory`). - Idempotent Create via `Idempotency-Key` and the `externalOrderId` fallback de-dup key. - Scheduled orders. - Provider routing/failover as observed externally. - Outgoing webhooks: full event catalog, payload schema, retry policy, and HMAC-SHA256 signature verification with worked examples in C#, JavaScript, and Python. - Returns (Phase 1: operator-resolved, no Order-Source-facing action). - PaymentMethod semantics (order metadata only — FleetBridge is not a payment processor). - Rate limiting (the current flat, IP-scoped guard — documented as-is, not as a business quota). - Certification self-test tooling. ## Versioning policy - **API major version** (`v1` in every path) changes only for a breaking change: a different wire format, a different auth mechanism, a different webhook signature algorithm, a newly required field, or a changed status/event semantic. A new major version ships with its own contract document and its own migration guidance — it never silently replaces `v1` in place. - **Minor/patch revisions** to this document (the `1.1.0` above) cover additive, backward-compatible changes within `v1`: a new optional field, a new event type, a new enum value that doesn't change what the existing ones mean. If you followed this guide's advice to ignore unknown JSON fields and tolerate unrecognized event types (Section 21), these changes won't touch you. - Every revision gets recorded above with its date. Need to know exactly what changed since you last integrated? Compare against the revision you originally built against.