- Start here
- Getting Started
- Development Store
- Build an app
-
App Development
-
Webhooks
- Guides by use case
- Popular APIs
-
Logistic Apps
- Reference
- Authentication
- API access scopes
- API call limit
- Response status codes
- API 3.0 reference ↗
- API 4.0 reference ↗
- EasyStore App Store ↗
Welcome 👋
Here you'll find everything you need to build on the EasyStore API. With it, you can integrate your service with EasyStore, sync data such as products, orders and stock, and add features to merchants' online stores.
Integrations are built as EasyStore Apps: merchants install your app, and your app gets an access token to call the API for their store. See What is an EasyStore App?
Start here
- Create a free Partner account. Register here. The EasyStore Partners program is for developers, designers, affiliates and marketing experts who build on EasyStore.
- Create a development store to install and test your app on. See Development Store.
- Create your app in the Partner Dashboard to get its Client ID and Client secret. See Create app.
- Install it on your development store and get an access token. See Develop app.
- Make your first API call with the access token:
curl 'https://{shop}/api/3.0/products.json' \ --header 'EasyStore-Access-Token: {access_token}'
What are you building?
Start with the App Development guide: create, develop and distribute.
🔄 Data syncERP, inventory, CRM or accounting: products, orders, inventory and customers.
🎨 A storefront featureWidgets and scripts on the online store with snippets and script tags.
📦 A shipping integrationCourier and logistics providers: rates, fulfillment, AWB and parcel status.
Building a payment integration? Contact dev@easystore.co for the payment integration guide.
Reference
- Authentication: the OAuth flow and request headers at a glance
- API access scopes: which permissions to request
- API call limit and Response status codes
- Webhooks: get notified when data changes
- Full endpoint references: API 3.0 and API 4.0