Maxmove LogoDocs

Die Entwicklerdokumentation ist auf Englisch verfügbar.

API reference

Base URL, authentication headers, security schemes, and links to every endpoint group of the Maxmove API v1 reference.

Als Markdown ansehen

The API reference is generated from the Maxmove API code and lists every endpoint of the Maxmove API v1 with its fields, responses, and error codes. It also lists the payload of each webhook event. Open it at api.maxmove.com/v1/docs.

Base URL#

https://api.maxmove.com/v1

Live and test keys use the same base URL. All paths in these docs are written as /v1/....

Authentication#

Send your API key with every request. The reference lists two security schemes for the same key; use either one:

SchemeHeader
partnerApiKeyx-api-key: mm_live_… or x-api-key: mm_test_…
partnerBearerAuthorization: Bearer mm_live_…

Create keys in the dashboard under Settings → API keys. See Authentication.

Endpoint groups#

GroupWhat it covers
Vehicle typesVehicle types you can book.
QuotesPrice a route before booking.
DeliveriesCreate, list, track, and cancel deliveries, and fetch proof of delivery.
WebhooksRegister and manage the endpoints that receive events.
Fleet ordersFor fleets: push your customers' orders onto your dispatch board.
Webhook eventsThe requests Maxmove sends to your webhook endpoints, one per event type.

Endpoints#

OperationEndpoint
List vehicle typesGET /v1/vehicle-types
Create a quotePOST /v1/quotes
Create a deliveryPOST /v1/deliveries
List deliveriesGET /v1/deliveries
Get a deliveryGET /v1/deliveries/{deliveryId}
Cancel a deliveryPOST /v1/deliveries/{deliveryId}/cancel
Get live trackingGET /v1/deliveries/{deliveryId}/tracking
Get proof of deliveryGET /v1/deliveries/{deliveryId}/proof-of-delivery
Create a webhook endpointPOST /v1/webhooks
List webhook endpointsGET /v1/webhooks
Update a webhook endpointPATCH /v1/webhooks/{webhookId}
Delete a webhook endpointDELETE /v1/webhooks/{webhookId}
Send a test eventPOST /v1/webhooks/{webhookId}/test
Retry failed eventsPOST /v1/webhooks/{webhookId}/replay
Create a fleet orderPOST /v1/fleet/orders
Get a fleet orderGET /v1/fleet/orders/{fleetOrderId}

Try requests#

The reference can send real requests. Use a test key (mm_test_…): test deliveries are never dispatched or billed.

A live key (mm_live_…) creates real, billable deliveries, also when you send the request from the reference.

OpenAPI document#

The OpenAPI 3.1 document is published at https://api.maxmove.com/v1/openapi.json. Use it to generate a client or to import the API into your HTTP tool. It contains only the public /v1 endpoints and the webhook payloads.

Guides#

The guides explain the workflows behind the endpoints: the quickstart, idempotency, errors, rate limits, and webhook signatures.

Hat das Ihre Frage beantwortet?