Glossary
Short definitions of the terms used in the Maxmove API and these docs, with links to the page that explains each one.
Deliveries and prices#
Delivery. One booked transport from a pickup to a dropoff, optionally with stops in between. Ids start with del_. See Deliveries and statuses.
Quote. A price for one route and vehicle type, valid for about 5 minutes. Ids start with qt_. Booking with its quote_id locks the price. See Quotes and prices.
Route. Everything a quote prices: pickup, stops, dropoff, vehicle_type_id, extras, items, and scheduled_at. A delivery booked with a quote must send the same route.
Waypoint. A place on the route: the pickup, a stop, or the dropoff. Each waypoint has an address with coordinates, and on a delivery a contact and optional instructions.
Vehicle type. The kind of vehicle that carries the delivery, for example courier. List them with GET /v1/vehicle-types. See Items and vehicle fit.
Items. Optional list of goods with dimensions and weight. Maxmove uses them to check that the vehicle type can carry them.
Extras. Optional services such as loading help, priced in the quote's breakdown.
Immediate delivery. A delivery without scheduled_at. Maxmove starts looking for a courier right away.
Scheduled delivery. A delivery with scheduled_at, the requested pickup time. See Scheduled deliveries.
Service area. The regions where Maxmove operates. Routes outside them answer 400 service_area_unavailable. See Coverage.
amount_cents. The total price in cents of currency, including VAT.
Statuses and tracking#
Status. Where a delivery stands: pending, courier_assigned, at_pickup, picked_up, in_transit, at_dropoff, and the final delivered or cancelled. Statuses only move forward.
Courier. The driver who picks up and delivers the goods.
Tracking page. A public page that shows the recipient where the delivery is. Its link is tracking_url on the delivery. See Track deliveries.
ETA. The expected time until the courier reaches the next waypoint, in eta_seconds of the tracking snapshot.
Proof of delivery. What the courier collects at handover, such as a signature, photos, or the recipient's name. See Proof of delivery.
Keys and modes#
API key. The secret your server sends in the x-api-key header. Keep it on your server and never in a browser or app. See Authentication.
Live mode. Requests with a live key (mm_live_…) create real deliveries that are dispatched and billed.
Test mode. Requests with a test key (mm_test_…) create simulated deliveries that are never dispatched or billed. See Test mode.
Robocourier. The simulated courier that moves test deliveries through every status.
Permission. What an API key may do, for example create deliveries or manage webhooks. You choose them when you create the key.
Workspace. Your business or fleet account in Maxmove. API keys, deliveries, and invoices belong to one workspace.
Requests and errors#
Idempotency key. The Idempotency-Key header that makes a create request safe to retry: a retry returns the original delivery instead of booking a second courier. See Idempotency.
external_id. Your own reference for a delivery, such as your order number. It is unique per mode.
Error code. The stable error.code in every error response, for example quote_expired. Branch on the code, not the message. See Errors.
Request id. The request_id in every error response. Send it when you contact support.
Rate limit. How many requests a key may send per time window. Over the limit, requests answer 429 rate_limited. See Rate limits.
Webhooks#
Webhook endpoint. A URL of yours that receives events. Ids start with we_. See Webhook events.
Event. One message Maxmove sends to your endpoint when something happens, for example delivery.status_updated. Ids start with evt_.
Signing secret. The whsec_… secret of an endpoint. Use it to check that an event really comes from Maxmove. See Verify signatures.
Replay. Sending failed events to an endpoint again. See Retries and replay.
Fleets and integrations#
Fleet. A transport company that runs its own drivers in Maxmove.
Fleet order. An order a fleet's customer pushes onto the fleet's dispatch board with POST /v1/fleet/orders. See Fleet order ingestion.
Integration. A ready-made connection to a shop system, AI assistant, or document archive that needs no code. See Integrations.
MCP server. The server that lets AI assistants such as ChatGPT and Claude quote, book, and track transports for a signed-in Maxmove user. See MCP server.
Did this answer your question?