API reference
Every operation of the LastMile Public API, generated from the OpenAPI document. The reference text is in English in both languages.
Base URL
Version v1
https://api.goldrock.live/api/public/v1Authentication
Send either of these on every request, except login and refresh.
- API key and secret: Company API key (starts with lmc_live_). Must be sent together with X-API-Secret. Secret of the API key, shown once when the key is created.
- Bearer token: Access token from POST /api/public/v1/auth/login.
Areas
- Auth3 operations
- POST /auth/login
- GET /auth/me
- POST /auth/refresh
- Branches2 operations
- GET /branches
- GET /branches/{id}
- Geography6 operations
- GET /geography/cities
- GET /geography/countries
- GET /geography/coverage
- GET /geography/coverage/cities
- …
- Merchants9 operations
- GET /merchants
- POST /merchants
- GET /merchants/{id}
- PUT /merchants/{id}
- …
- Pricing1 operations
- POST /pricing/quote
- Shipments8 operations
- POST /shipments
- GET /shipments
- GET /shipments/statuses
- GET /shipments/{trackingNumber}
- …
- Webhooks6 operations
- GET /merchants/{merchantId}/webhooks
- POST /merchants/{merchantId}/webhooks
- DELETE /merchants/{merchantId}/webhooks/{id}
- POST /merchants/{merchantId}/webhooks/{id}/rotate-secret
- …
- SchemasEvery data type used in requests and responses. Each name is a link target, so a field type in the operation pages jumps here.
OpenAPI document
The same document is served live by the API at /api/public/v1/openapi.json. Download it to generate a client or to import the API into Postman or Insomnia.
Download public-v1.openapi.json
Import into Postman or Insomnia
- Download the OpenAPI file above (or copy the live URL of the API).
- Postman: Import, then choose the file or paste the URL. Insomnia: Create, then Import, and pick the file or the URL.
- Add your API base URL as the server (the file has no server list) and set the X-API-Key and X-API-Secret headers, or a bearer token, on the collection.