Using the API well
Changelog
Dated API versions and notable additions. Additions within a version are never breaking; see versioning.
Recent additions
26 September 2026
- The official SDKs’
X-ShipMessages-Client header is accepted and shown as client on each entry of the request log (GET …/request-logs). Before this, requests made with the SDKs were refused. GET /v1/errors entries now include each code’s message.- SDKs are packaged for npm, PyPI, Packagist, Go modules, Maven Central and NuGet.
- Public documentation is available without a console session.
- Risk review events identify their resource as
risk_decision, matching the API. - Unsupported HTTP methods return 405; validation errors name unrecognized fields.
- Browser sign-in and staff-only operations are excluded from the customer API contract.
API versions
2026-08-21
CurrentReleased 21 August 2026
The current dated version.
Supported.
2026-05-15
DeprecatedReleased 15 May 2026
Superseded by 2026-08-21. Move to 2026-08-21 before 21 August 2027.
Deprecated on 21 August 2026; accepted until 21 August 2027.