Quick Start

Introduction

Shoplazza API help Store Admins and App developers to manage stores with efficiency.

Explore Shoplazza API reference and templating documentation. You have access to everything from the Admin API.

This QUICKSTART guide intends to walk you through 6 steps to use the APIs, and hopefully, after this journey, you would know how to use Shoplazza APIs to manage stores.


1. Apply to be a Shoplazza Partner

Before you use Shoplazza's Open API to build your apps to provide services for merchants, your need to submit your application for the shoplazza partner to obtain the App Client ID and Client Secret, which are used as follows:

  • Used as the identification while using the Shoplazza's Open APIs,
  • Used to show your identity during the merchants authorization process.

You can submit your partner application as follows:

📘

Submit your partner application

Please contact the developer of Shoplazza via email ([email protected]) to obtain the Client Key and Client Secret. During this process, you need to provide basic information as follows:

Company Information:

  • Company business brief introduction.
  • Official website address.
  • Partner contact email.

App basic information:

  1. App URL, which app provide service via this URL as the main entrance.
  2. Redirect URI, which is used for the OAuth callback address.
  3. App icon (size 150x150, PNG format).
  4. Email address for contact.
  5. App name, both in Chinese and English.
  6. App brief description, both in Chinese and English.
  7. Permissions you app needed: store information, customers, orders, products (see developer documentation for details) etc.

After review process by Shoplazza's developer, you will receive an email which contains your app's Client ID and Client Secret.

🚧

Further notice

The way to apply to be shoplazza partner described above will be changed to a more easier and more self assistant way through Partner Center website in the future, stay tuned for the further notice!

For more detail steps, please checkout OAuth - Step 1: Obtain the Client ID & Client Secret .

2. Obtain Client ID & Client

After review process passed by Shoplazza's developer, you will receive an email which contains your Client ID and Client Secret.

You can save the Client ID and Client Secret for later used for app development.


3. Apply for the development store

Developers need to apply for the store when developing apps for app's testing and verification .

You can submit your development store application as follows:

📘

Submit your development store application

Register a new store

Apply your store as a development store
Send following infos to [email protected]

  • Store ID
  • Duration (in days)
  • Purpose of application
  • Application Name

After review process passed by shoplazza, your store is opened for the app development.

For more detail steps, please checkout Apply Developer Store.

🚧

Future notice

The way to apply development store described above will be changed to a more easier and more self assistant way through Partner Center website in the future, stay tuned for the further notice!

4. OAuth

After you get your Client key and Client Secret, then you have to let your app to get merchants permission to use Open API to read and write their data by go through the OAuth process.

Follow OAuth - Step 2: Get API Access Token to get merchants permission to get the API Access Token.


5. Make authenticated requests

After your app has retrieved an API Access Token, your app can make authenticated request to Admin API.

Follow OAuth - Step 3: Make authenticated requests to learn more how to make authenticated requests.

6. Submit your app to app store

When you finished app development, you could submit app-submission to make you app accessible in app store for countless merchants to install and use.

You can submit your app-submission as follows:

📘

Submit your app-submission

Send your app-submission information to [email protected] as follows:
Company Information:

  • Official website address.
  • Partner contact email.

App basic information:

  1. App name, both in Chinese and English.
  2. App brief description, both in Chinese and English.
  3. Redirect URI, which is used for the OAuth callback address.
  4. Client ID, for the double confirmation.
  5. App testing screenshots, used for the app functional verification.

After review process by Shoplazza's developer, you will receive an email which would tell your app is live in app store.

🚧

Future notice

The way to submit your app-submission described above will be changed to a more easier and more self assistant way through Partner Center website in the future, stay tuned for the further notice!