Merchant API
The Merchant API is a REST API for shop administrators. Through it an external accounting system (a CRM, an ERP, a warehouse program) synchronises data with the shop: uploads prices and stock, reads and updates orders and their statuses.
The full contract with the schemas of every field is in the OpenAPI specification. This documentation explains how to use it.
Base address
Every method sits under the /api/merchant-service/... prefix. The service base
address is:
https://admin.mobiusapp.ioA full method URL looks like this:
https://admin.mobiusapp.io/api/merchant-service/orders/listAuthentication
Access is by bearer token. A token is issued against the email and password of the shop account, then passed in the header of every protected request:
Authorization: Bearer <token>See Authentication.
Shop context
The shop is determined automatically from the bearer token: there is no need to pass its identifier in requests. All data (orders, prices, stock) is read and written in the context of the shop attached to the account. If no active shop is attached to the account, the method returns a business error (422).
Synchronous and asynchronous methods
| Group | Mode | Behaviour |
|---|---|---|
| Authentication, orders | synchronous | the result comes back in the response |
| Price and stock import | asynchronous |
the request is queued and the response returns a task_id |
Sections
- Authentication: obtaining and using a bearer token, sign-in limits.
- Errors, limits and pagination: error formats, HTTP statuses, rate limiting, paged output.
- Importing prices and stock: batch upload of prices and stock per warehouse.
- Orders: filtered list, single order, updates, status changes, cancellation.
Where to start
- Get a bearer token, see Authentication.
- Upload prices and stock, see Importing prices and stock.
- Read and update orders, see Orders.
- To react to shop events (an order created, paid, cancelled) in real time, connect webhooks.
Related pages
- Webhooks: shop events at your own URL.
- OpenAPI documentation: the schemas of every field.