Overview
Shoplazza offers a suite of APIs that allow developers to extend the platform’s built-in features. These APIs allow partners to read and write merchant data, interoperate with other systems and platforms, and add new functionality to Shoplazza. API Usage
Requirements for Using Shoplazza APIs
- All APIs are subject to the Shoplazza API License and Terms of Use.
- Authentication is required for all API usage.
- The Admin API supports REST API.
- This is a versioned API. Updates are released every half year.
- Apps must explicitly request the relevant access scopes from merchants during installation.
- Apps must authenticate to interact with the Admin API.
- The Admin API enforces rate limits on all requests. Note that there are rate-limiting REST API. All apps and services connecting to the Admin API are subject to Shoplazza's API Terms of Service.
Shoplazza Admin APIs
The Admin API is used to read and write data about merchant stores, products, orders, and more. You can use the Admin API to build apps that add features to the Shoplazza admin, the store management interface used by merchants. The Admin API is accessible using REST.
Shoplazza API Rate Limits
For more details please check rate limits.
Differences from other chapters
| What you want to do | Where to go |
|---|---|
| Walk through steps to get your first public app running from scratch | Create a Public App tutorial |
| Look up request/response fields of a specific endpoint | API Endpoint List (auto-generated by OpenAPI) |
| Look up general conventions on authentication, rate limits, signatures, pagination, etc. | This chapter (read on) |
Topic Navigation
- Using the API — Calling conventions, request format, authentication headers
- OAuth Authentication — Installation and authorization flow for public apps, Access Token / Refresh Token
- Access Scopes — Requesting, changing, and re-authorizing
- HMAC Signature Verification — Signature algorithm for OAuth callbacks, Webhooks, etc.
- Rate Limits — Request frequency constraints and best practices
- Pagination — Pagination conventions for list endpoints
- HTTP Status Codes — Error codes and troubleshooting guidance
- Common Parameters — Generic query/sort parameters
- Resource ID Conventions — Values and encoding of store_id, object_id, etc.