API reference

This reference is generated from the allowlisted OpenAPI projection checked in CI. It contains two read-only service-health operations and their complete publication-safe response schemas.

No public host is advertised. The application and API hosts remain authenticated. Operational order, shipment, carrier, rate, label, and writeback APIs are not part of this public contract.

Contract at a glance

Method	Path	Description
`GET`	`/healthz`	Check process liveness
`GET`	`/readyz`	Check dependency readiness

GET/healthz

Check process liveness

Reports that the API process is alive. It does not prove dependency readiness.

Responses

Status	Meaning
`200`	Process is alive
`429`	Request was rate limited by an ingress control

GET/readyz

Check dependency readiness

Reports whether the API can safely receive operational traffic.

Responses

Status	Meaning
`200`	API is ready
`429`	Request was rate limited by an ingress control
`503`	API is not ready

Response schemas

Responses use closed JSON objects. Fields not listed in the schema are not part of the public contract.

Health

Field	Type	Requirement	Constraint
`status`	string	Required	Exactly “ok”

Readiness

Field	Type	Requirement	Constraint
`status`	string	Required	ready or not_ready

Problem

Field	Type	Requirement	Constraint
`code`	string	Required	Validated identifier format
`message`	string	Required	—
`request_id`	string	Required	Validated identifier format

Rate limiting and readiness

A 429 response may include Retry-After in seconds. Back off; do not create a request loop.
A 503 response from /readyz means the process is reachable but should not receive new operational traffic.
A 200 response from /healthz proves process liveness only. It does not prove dependencies, product availability, or provider connectivity.

Contract version

0.4.1 · OpenAPI 3.1.0. Additive or breaking operational APIs will not appear here until their own publication and access gates are approved.