OpenAPI reference

Updated 2026-09-07

The OpenAPI document is the source of truth for request/response schemas. Use it to generate clients or explore in Postman, Insomnia, or Swagger UI.

Fetch the spec

curl -sS https://nitromule.com/api/integrations/v1/openapi.json | jq '.info'

Inspect paths:

curl -sS https://nitromule.com/api/integrations/v1/openapi.json | jq '.paths | keys'

Suggested workflow

1. Import openapi.json into Postman or Insomnia.
2. Set a collection variable api_key to a nm_test_… key.
3. Add a collection auth header: Authorization: Bearer {{api_key}}.
4. Run in order: carriers → addresses/validate → rates → orders → shipments → void → tracking.
5. Compare with the five canonical scripts in Quickstart.

What to trust

When a curl snippet and OpenAPI disagree, OpenAPI wins.

Versioning

The API is versioned under /api/integrations/v1. Read info.version inside the spec. Breaking changes land on a new version path.

Errors to expect

Related: Authentication, Test mode.