API access quickstart and authentication

Get started with the Maxmove Partner API: create an API key, select scopes, and create your first test delivery.

Use the Maxmove Partner API to quote, create, and track deliveries directly from your shop, ERP, TMS, or application.

Create an API key

API keys are organization-scoped and can be created and revoked under API keys in the Maxmove dashboard.

  • mm_test_… creates simulated deliveries only. No courier is dispatched and no delivery charge is incurred.
  • mm_live_… creates real, billable deliveries.
  • Send the key in the x-api-key header. Authorization: Bearer mm_… is also supported.
  • Restrict each key to the required scopes: quotes:create, deliveries:read, deliveries:write, and webhooks:manage.
  • Fleet integrations additionally use fleet_orders:create and fleet_orders:read for order ingestion.

Create your first test delivery

  1. Call GET /partner/v1/vehicle-types and select a vehicle_type_id.
  2. Quote the route with POST /partner/v1/quotes.
  3. Create the delivery with POST /partner/v1/deliveries, the returned quote_id, and a unique Idempotency-Key.
  4. Read the delivery and tracking state with GET /partner/v1/deliveries/{id} and GET /partner/v1/deliveries/{id}/tracking.
  5. Register an endpoint with POST /partner/v1/webhooks for automatic status updates.

All requests and responses use snake_case. Timestamps use RFC 3339 UTC; money uses an amount in cents plus a currency.

Before switching to live mode

  • Test success, cancellation, and failure paths with an mm_test_… key.
  • Verify webhook signatures over the unchanged raw request body.
  • Store API and webhook secrets in a secure secret manager.
  • Switch to an mm_live_… key when ready; endpoints and payloads remain the same.

The full interactive reference is available at https://api.maxmove.com/partner/v1/docs; the OpenAPI specification is available at https://api.maxmove.com/partner/v1/openapi.json.

Was this article helpful?

Related articles