Shoplazza REST API overview
Shoplazza offers a suite of APIs that let developers extend the platform. The Admin API — accessible over REST — lets partners read and write merchant data such as stores, products, and orders, interoperate with other systems and platforms, and add features to the Shoplazza admin, the store-management interface used by merchants. To start calling it, see API Usage.
Requirements for Using Shoplazza APIs
- All use of the Shoplazza APIs is subject to the Shoplazza API License and Terms of Service.
- Every request requires authentication.
- Apps must explicitly request the relevant access scopes from merchants during installation.
- This is a versioned API, with updates released every six months.
- The Admin API enforces rate limits on all requests.
Number of Endpoints
The table below gives the number of public Admin API endpoints in each version. They match the endpoints listed in the API reference.
| Version | Public endpoints |
|---|---|
| 202701 | 360 |
| 202607 (default) | 360 |
| 202601 | 360 |
| 202506 | 271 |
| 202201 | 219 |
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