API Usage

API Public Parameters

See Details: https://www.shoplazza.dev/reference/api-public-parameters

Restful API

Once you have obtained the Access Token for your application, you can construct RESTful API requests to access Shoplazza’s APIs. The request URL must include the version number to correctly identify which API version you need, using the following format:

RESTful API URL： https://{shopdomain}.myshoplaza.com/openapi/{ version }/{ endpoint }

For example, the following URL calls version 2025-06：

RESTful API URL： https://{shopdomain}.myshoplaza.com/openapi/2025-06/articles

Noted

All endpoints are only accessible via HTTPS.

The base domain is formatted as https://{shopdomain}.myshoplazza.com, where {shopdomain} represents your store’s unique domain.

When using the “Try out” feature in this document, {shopdomain} is pre-filled with a testing store provided by Shoplazza for ease of navigation.

Example of Restful API Call

The following curl request retrieves information by using the Article API and the GET /openapi/2025-06/articles endpoint. Replace {shopdomain} with your store’s domain and {token} with the access token you generated in the Authentication section.
Request:

curl -X GET \
  https://{shopdomain}.myshoplaza.com/openapi/2025-06/articles/id \-H 'Content-Type: application/json' \-H 'Access-Token: {token}'

Response Example：

{
   "code" : "string",
   "message" : "string",
   "data" : {
      "article" : {
         "author" : "string",
         "blog_ids" : [
            "string"
         ],
         "content" : "string",
         "created_at" : "string",
         "excerpt" : "string",
         "handle" : "string",
         "id" : "string",
         "image" : {
            "height" : 0,
            "path" : "string",
            "src" : "string",
            "width" : 0
         },
         "published" : true,
         "published_at" : "string",
         "seo_description" : "string",
         "seo_keywords" : [
            "string"
         ],
         "seo_title" : "string",
         "title" : "string",
         "updated_at" : "string"
      }
   }
}

If your application calls a version that is no longer supported, it will return a 404 status upon the request call.

Cursor Pagination

See Details: https://www.shoplazza.dev/reference/pagination

How to retrieve IDs

See Details: https://www.shoplazza.dev/reference/global-ids