Skip to content
Same-day windows · every order tracked live
Developers

The MXLaMove API.

REST over HTTPS, JSON in and out, scoped keys for business accounts. Everything the web and mobile apps do goes through these endpoints.

Quick start

Base URL: /api/v1. All timestamps are ISO-8601 UTC. Money is integer minor units (paise).

Authentication

Password sign-in issues a short-lived access token and a rotating refresh token. Send the access token as a bearer header.

POST /api/v1/auth/login
{ "email": "ops@mxlamove.dev", "password": "••••••••" }

Quotations

A quote prices the stops, vehicle and surcharges. It is valid for 10 minutes and is required to create an order.

POST /api/v1/quotes
{ "cityId": "…", "vehicleTypeId": "…", "stops": [
  { "kind": "pickup", "lat": 12.97, "lng": 77.59 },
  { "kind": "drop", "lat": 12.93, "lng": 77.62 }
] }

Orders

Booking converts a quote into an order, generates the customer code and starts dispatch. State changes are appended to the order timeline.

POST /api/v1/orders
Idempotency-Key: <uuid-per-action>
{ "quoteId": "…" }

GET /api/v1/orders/:id

Tracking

Public tracking by order code returns status, stop progress and the latest position without exposing customer data.

GET /api/v1/track/MXL-XXXXXXXX

Webhooks

Business webhooks are signed with HMAC-SHA256 over the raw body in the X-MXL-Signature header. Retries use exponential backoff.

order.assigned · order.picked_up
order.delivered · order.cancelled

Errors

Errors are JSON with a stable code and a human message. Validation failures return 400 with field details.

{ "code": "invalid_state",
  "message": "This job cannot be failed" }

Conventions

  • Bearer access tokens expire after 15 minutes; refresh tokens rotate on use.
  • Ids are cuids; order codes are human-readable MXL-XXXXXXX.
  • Paginated collections accept limit and cursor and return nextCursor.
  • Idempotency-Key is required on order creation, cancellation, rebooking, dispatch, offer acceptance, wallet top-ups, payments and refunds. Reuse the same key only when retrying that action.
  • Business writes require the API key scope shown in the reference.
  • Sandbox uses the seeded dev database; never send real customer data.