Customer API
Welcome to the Midla Platform Customer API documentation. This section is for customers whose account has the customer role and API access enabled by their service provider. Use it to query your own master shipments and receipts, and create receipts from your system.
If you need to learn how to use the customer portal from the web interface, that documentation lives in the Documentation section.
How authentication works
You authenticate with a single access token, generated by you from your own portal — there are no scopes to choose. The token permits the operations listed below, including receipt creation. Receipts and masters are scoped to your customer account; catalogs and related partner details are returned according to the endpoint contract. See Authentication for details.
What can you do with the Customer API?
- Look up your own receipts (
receipts) and their status. - Look up your own master shipments (
masters) and their status, route, and tracking. - Resolve general catalogs (countries, states, document types, currencies, package types, commodities, operation types, warehouses) to interpret the data above or build your own UI.
You can create receipts with POST /receipts. The customer is assigned from your token;
do not send customer_id or customer. At least one package is required.
Customer API does not expose receipt updates/deletion or master creation/updates/deletion.
See Create receipt for the request schema.
How this section is organized
| Page | Content |
|---|---|
| Getting started | How to generate your token from the portal and make your first request. |
| Authentication | How your single token works, and why there are no scopes to choose. |
| API Reference | Full reference for every available endpoint. |
| Errors and response codes | Error format and what each HTTP status code means. |
| Rate Limits | API usage limits and how to handle them. |
| API Changelog | History of changes to this API. |
Before you start
The organization you work with needs to have enabled your API access — ask your contact there to turn it on from their panel. Once enabled, you generate your own token from your own portal (see Getting started).