Release Notes

API version release notes

Release notes list all of the changes that are introduced by an API version. Use them to check whether your app is compatible with an API version, and what changes you might need to make before you migrate your app.
Version naming is done in a date format, and currently there are three versions: 2020-01, 2020-07, and 2022-01. It is recommended to start by looking for the content you need in the 2022-01 version.


2022-01 release notes

Release dateDate version is not available yet
Jan 31, 2022Jan 1, 2023

Currently, most newly added applications are adopting this version, which is also the stability version that Shoplazza focuses on maintaining. The vast majority of new interfaces and features will be updated from this version.

The main components include: core interfaces related to the business blocks of products and extended fields (Metafield), styles, albums, product images, orders, logistics, transactions, stores, order risks, marketing (coupon codes, promotions, quantity discounts), reviews, buyers, inventory, Billing API, themes, custom pages, theme files, script_tags, and data analysis.

Breaking changes

These changes require special attention. If your app uses these API resources and you don’t upgrade to a more recent API version, then your app will break.

Rate Limits

The REST Admin API supports a limit of 40 requests per app per store per minute. This allotment replenishes at a rate of 2 requests per second.


Cursor-based pagination has been implemented across Get Product List endpoints, and more are expected to support cursor-paged pagination in upcoming versions.

Idempotent requests

If an API request is disrupted in transit, then you might not receive a response. By including an idempotency key in your request, repeated requests with the same parameters will be executed only once, no matter how many times the request is retried.

Access Scopes

Add Get Access Scopes endpoint to get the list of access scopes associated with the access.

Payment app Open API support

Payment apps are public apps that integrate with the Shoplazza to provide payment processing services. Only approved partners will be able to build payment apps on Shoplazza's Payment Platform.
Using a payment app, merchants can redirect buyers to an app-hosted page for payment processing, which may include the following payment methods:

  • Wallets
  • Buy Now Pay Later / Installments / Buyer Financing
  • Cards
  • Bank Transfers / Online Banking
  • Cryptocurrency
  • Cash + ATM

Order Risk

Add Order Risk endpoint to get the risk information of orders.


Release dateDate version is no longer updated
July 1, 2020July 1, 2021


Release dateDate version is no longer supported
January 1, 2020January 1, 2021

Development Preview Version

Shoplazza releases new API versions every six months, and each version supports at least 12 months. The version name is based on the date, such as 2020-01. If your application calls a version that is no longer supported, it will return a 404 status when calling the request.

API with version

RESTful API URL: /openapi/{ version }/{ endpoint }.json

For example, the following URL calls version 2020-01:

RESTful API URL: /openapi/2020-01/products.json

Development Preview API

In order to quickly develop and iterate new API versions, we will also provide a development preview version of the API. The development preview version contains some experimental functional APIs, which may be unstable. Some APIs will be backward compatible, but some will not, and there is no guarantee that they will not be modified before becoming a stable version. If you The development preview version is used, please feel free to follow our version Change logs.


The release of this version will be backward compatible with the previous historical version (API version released before 2020), that is, when you call:

RESTful API URL: /openapi/products.json


RESTful API URL: /openapi/api/open/products.json

Both are consistent with the results obtained by the following new calling method:

RESTful API URL: /openapi/2020-01/products.json

For reasons of forward compatibility, if your request does not include a version, the system will use the current stable version (2020-01) by default. We recommend that you migrate to the calling method with version number as soon as possible. In addition, please be aware that version calls after 2020-01 must be accompanied by the version number).