Guides
Find the API for your business
Whatever your company does, this page points you to the scopes, endpoints and events your app needs.
Pick your business
| Your business | What your app does | Guide |
|---|---|---|
| Delivery or shipping company | Offers a price at checkout, receives paid orders, reports tracking | Delivery companies |
| Warehouse or fulfilment center | Picks paid orders by SKU, keeps stock, reports shipments | Warehouses and fulfilment |
| Point of sale or ERP | Keeps products, stock and orders in step with your system | Warehouses and fulfilment |
| Supplier or dropshipping | Adds products, keeps price and stock fresh, ships orders | Suppliers and dropshipping |
| Digital cards and subscriptions | Adds codes, delivers content by hand, resends it | Digital products and delivery |
| Accounting or invoicing | Reads paid and refunded orders and the store's tax details | Accounting and invoices |
| SMS, WhatsApp or email | Tells customers about their orders and carts | Marketing and customer messages |
| Marketing and ads | Makes coupons, follows campaigns, wins back carts | Marketing and customer messages |
| Loyalty and rewards | Finds customers, adds and removes points | Customers and loyalty |
| Customer support and reviews | Finds a customer's orders, answers questions and reviews | Customer support and reviews |
| Reports and analytics | Reads sales figures and orders | Analytics |
What most apps ask for first
| I want to | Call | Scope |
|---|---|---|
| Get new and paid orders | order.paid or GET /orders | orders:read |
| Get the customer's phone and address on an order | customer and shipping_address on the order | customers:read |
| Find a customer by phone or email | GET /customers | customers.list:read |
| Find an order by its number | GET /orders?number=200123 | orders:read |
| Send a tracking number | PATCH /orders/{id}/shipment | orders.shipment:write |
| Change the order status | PATCH /orders/{id}/status | orders.status:write |
| Notify the customer | POST /orders/{id}/notifications | customers.notify:write |
| Find a product by SKU | GET /products?sku=TS-100 | products:read |
| Change stock | POST /products/{id}/inventory-adjustments | inventory:write |
| Read the store's address and tax number | GET /store | store:read |
Request only what your app uses. The merchant sees every scope before installing, and the scope list says what each one opens.
Not available
These stay with the merchant, or the store does not hold them today:
- Refunds and marking an order as paid. Only the merchant does these, from the dashboard.
- Payment details.
GET /paymentsgives the outcome only: no amount, method or card. - Creating an order on a customer's behalf.
- Customer wallet balance, reading or changing it.
- VAT per order and invoice numbers. See Accounting and invoices.
- A live delivery price from your server. Delivery options have fixed prices.
- Stock per branch. Each product or choice has one quantity.
- Free-text text messages. Text messages have fixed wording. Your app can send free text through its own provider, as in Marketing and customer messages.