REST API reference
Read and manage a merchant's orders, products, customers and more over HTTPS with JSON. Every request is scoped to one shop and to the permissions the merchant granted your key or app.
# Base URL
https://api.ecomone.shop/api/public/v1Every endpoint has a Try it console. Add your credentials once and send live requests straight from these docs. Requests go directly from your browser to the API; your key never touches this site.
Resources
Orders
Orders of the shop, including computed VAT/fee/profit fields and marketing attribution.
Products
Product catalog (read-only over REST).
Customers
Customers are not a separate table: they are aggregated from the shop's orders by lower-cased e-mail.
Collections
Product collections.
Discounts
Discount codes.
Reviews
Product reviews.
Inventory
Stock levels per product and variant: list them, and set or adjust them in bulk.
Revenue
Revenue, fees and profit report (summary plus time series).
Accounting export
Accounting export: all invoices and credit notes of a period as one CSV file for your bookkeeping software.
All endpoints
| Method | Path | Description | Scope |
|---|---|---|---|
| GET | /api/public/v1/orders | List orders | orders:read |
| GET | /api/public/v1/orders/{id} | Retrieve an order | orders:read |
| PATCH | /api/public/v1/orders/{id} | Update an order | orders:fulfillment | orders:notes | orders:cancel (per field) |
| GET | /api/public/v1/orders/{id}/journey | Retrieve an order’s customer journey | orders:read |
| GET | /api/public/v1/products | List products | products:read |
| GET | /api/public/v1/products/{id} | Retrieve a product | products:read |
| GET | /api/public/v1/customers | List customers | customers:read |
| GET | /api/public/v1/customers/{id} | Retrieve a customer | customers:read |
| GET | /api/public/v1/collections | List collections | collections:read |
| GET | /api/public/v1/collections/{id} | Retrieve a collection | collections:read |
| GET | /api/public/v1/discounts | List discount codes | discounts:read |
| GET | /api/public/v1/discounts/{id} | Retrieve a discount code | discounts:read |
| GET | /api/public/v1/reviews | List reviews | reviews:read |
| GET | /api/public/v1/reviews/{id} | Retrieve a review | reviews:read |
| GET | /api/public/v1/inventory | List stock levels | inventory:read |
| POST | /api/public/v1/inventory | Update stock levels | inventory:write |
| GET | /api/public/v1/revenue | Get a revenue report | revenue:read |
| GET | /api/public/v1/invoices/accounting | Export invoices for accounting | orders:read |