Getting started
Permissions
A key (or an app) holds a list of permissions. Each endpoint names the one it needs; without it the call answers 403 insufficient_scope. Ask only for what you use — the merchant sees the list before approving.
| Permission | Allows |
|---|---|
orders.read | View orders |
orders.write | Modify orders |
orders.confirm | Record the customer's order confirmation |
products.read | View products |
products.write | Modify products |
categories.read | View categories |
customers.read | View customers |
carts.read | View abandoned carts |
shipping.read | View shipping zones |
shipping.write | Update shipping zones |
coupons.read | View coupons |
reports.read | View reports |
webhooks | Receive event webhooks |