# API reference

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

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](https://api.maxmove.com/v1/docs).

## Base URL

```text
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:

| Scheme | Header |
| --- | --- |
| `partnerApiKey` | `x-api-key: mm_live_…` or `x-api-key: mm_test_…` |
| `partnerBearer` | `Authorization: Bearer mm_live_…` |

Create keys in the [dashboard](https://dashboard.maxmove.com) under **Settings → API keys**. See [Authentication](https://maxmove.com/en/developers/docs/authentication).

## Endpoint groups

| Group | What it covers |
| --- | --- |
| [Vehicle types](https://api.maxmove.com/v1/docs#tag/vehicle-types) | Vehicle types you can book. |
| [Quotes](https://api.maxmove.com/v1/docs#tag/quotes) | Price a route before booking. |
| [Deliveries](https://api.maxmove.com/v1/docs#tag/deliveries) | Create, list, track, and cancel deliveries, and fetch proof of delivery. |
| [Webhooks](https://api.maxmove.com/v1/docs#tag/webhooks) | Register and manage the endpoints that receive events. |
| [Fleet orders](https://api.maxmove.com/v1/docs#tag/fleet-orders) | For fleets: push your customers' orders onto your dispatch board. |
| [Webhook events](https://api.maxmove.com/v1/docs#tag/webhook-events) | The requests Maxmove sends to your webhook endpoints, one per event type. |

## Endpoints

| Operation | Endpoint |
| --- | --- |
| [List vehicle types](https://api.maxmove.com/v1/docs#tag/vehicle-types/GET/v1/vehicle-types) | `GET /v1/vehicle-types` |
| [Create a quote](https://api.maxmove.com/v1/docs#tag/quotes/POST/v1/quotes) | `POST /v1/quotes` |
| [Create a delivery](https://api.maxmove.com/v1/docs#tag/deliveries/POST/v1/deliveries) | `POST /v1/deliveries` |
| [List deliveries](https://api.maxmove.com/v1/docs#tag/deliveries/GET/v1/deliveries) | `GET /v1/deliveries` |
| [Get a delivery](https://api.maxmove.com/v1/docs#tag/deliveries/GET/v1/deliveries/{deliveryId}) | `GET /v1/deliveries/{deliveryId}` |
| [Cancel a delivery](https://api.maxmove.com/v1/docs#tag/deliveries/POST/v1/deliveries/{deliveryId}/cancel) | `POST /v1/deliveries/{deliveryId}/cancel` |
| [Get live tracking](https://api.maxmove.com/v1/docs#tag/deliveries/GET/v1/deliveries/{deliveryId}/tracking) | `GET /v1/deliveries/{deliveryId}/tracking` |
| [Get proof of delivery](https://api.maxmove.com/v1/docs#tag/deliveries/GET/v1/deliveries/{deliveryId}/proof-of-delivery) | `GET /v1/deliveries/{deliveryId}/proof-of-delivery` |
| [Create a webhook endpoint](https://api.maxmove.com/v1/docs#tag/webhooks/POST/v1/webhooks) | `POST /v1/webhooks` |
| [List webhook endpoints](https://api.maxmove.com/v1/docs#tag/webhooks/GET/v1/webhooks) | `GET /v1/webhooks` |
| [Update a webhook endpoint](https://api.maxmove.com/v1/docs#tag/webhooks/PATCH/v1/webhooks/{webhookId}) | `PATCH /v1/webhooks/{webhookId}` |
| [Delete a webhook endpoint](https://api.maxmove.com/v1/docs#tag/webhooks/DELETE/v1/webhooks/{webhookId}) | `DELETE /v1/webhooks/{webhookId}` |
| [Send a test event](https://api.maxmove.com/v1/docs#tag/webhooks/POST/v1/webhooks/{webhookId}/test) | `POST /v1/webhooks/{webhookId}/test` |
| [Retry failed events](https://api.maxmove.com/v1/docs#tag/webhooks/POST/v1/webhooks/{webhookId}/replay) | `POST /v1/webhooks/{webhookId}/replay` |
| [Create a fleet order](https://api.maxmove.com/v1/docs#tag/fleet-orders/POST/v1/fleet/orders) | `POST /v1/fleet/orders` |
| [Get a fleet order](https://api.maxmove.com/v1/docs#tag/fleet-orders/GET/v1/fleet/orders/{fleetOrderId}) | `GET /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.

> **Warning:**
> 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`](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](https://maxmove.com/en/developers/docs/quickstart), [idempotency](https://maxmove.com/en/developers/docs/concepts/idempotency), [errors](https://maxmove.com/en/developers/docs/concepts/errors), [rate limits](https://maxmove.com/en/developers/docs/concepts/rate-limits), and [webhook signatures](https://maxmove.com/en/developers/docs/webhooks/verify-signatures).

---

Source: https://maxmove.com/en/developers/docs/api-reference