Skip to main content

Changelog

All notable changes to the Flex Forward API and documentation are listed here in reverse chronological order.

June 2026

Added

  • Endpoint: GET /couriers — list courier codes available to your account. Use a returned code value as courier when creating labels or listing courier products.

May 2026

Added

  • Endpoint: GET /products — list available shipping products for a courier. Use the returned product codes when creating labels.
  • Authentication: API key + token header authentication (x-rr-apikey / x-rr-apitoken) supported as an alternative to bearer token authentication.
  • Endpoint: GET /labels/{id} — now accepts comma-separated identifiers (label UUIDs or customer order numbers) for batch retrieval. Missing or failed labels are omitted from the response.
  • Response: GET /labels/{id} response now includes customerOrderNumber field.

Changed

  • Breaking: shipperAccountId removed from the label creation request. The field is not required in the service object.
  • API spec: Enriched with detailed descriptions, examples, and operation IDs across all endpoints.
  • Documentation: Improved quickstart guide, request samples, and general fixes.

v1.0.0

Initial public release of the Flex Forward API and developer documentation.

Added

  • Endpoints: POST /labels (create shipping label), GET /labels/{id} (retrieve label document URL), GET /tracking/{id} (retrieve shipment tracking)
  • Production courier: YunExpress with global cross-border e-commerce shipping lanes
  • Idempotency: Built-in duplicate prevention for label creation via idempotencyKey
  • Unified tracking: Normalized status tags (Pending, InfoReceived, InTransit, Delivered, Exception, Cancelled, Unknown) and structured checkpoint format across all couriers
  • Authentication: Bearer token authentication with separate tokens for production and development environments
  • Documentation: Quickstart guide, authentication reference, error handling guide, idempotency and retry patterns, environment details, core concepts, versioning policy, and FAQ