Nitromule

Nitromule Integrations API

Updated 2026-09-07

On this page

The Integrations API is how OMS tools, custom stores, and automations create orders, shop UPS/USPS/FedEx rates, buy labels, track, void, and subscribe to webhooks — with optional MCP for agents.

Base URL

https://nitromule.com/api/integrations/v1

OpenAPI: GET /openapi.json (also GET /api/integrations/v1/openapi.json on the app host).

Auth

Send your API key on every request:

  • Authorization: Bearer nm_test_… or nm_live_…, or
  • X-API-Key: nm_test_… / nm_live_…

Details: Authentication · Test mode

Core resources

Resource Use
Orders Create/list/update Incomplete orders
Rates Multi-carrier rate shop without buying
Shipments Buy, get, void labels; return labels
Tracking Track by number or order id
Addresses Validate before you rate
Webhooks order.*, shipment.*, tracking.updated
Carriers / packages / ship-from Read helpers for OMS UIs
Batches / manifests / pickups Ops helpers when enabled in OpenAPI

Canonical flows

  1. OMS push — POST /orders → POST /rates → POST /shipments
  2. Rate-only — POST /rates (no buy)
  3. Label lifecycle — buy → get → POST …/void
  4. Tracking — POST /tracking after purchase
  5. Idempotency — replay with the same Idempotency-Key

Walkthrough with curl: Quickstart.

Also on docs