Getting started

Shoplazza apps can extend the admin panel, online store, checkout flow, and backend services. Below is organized along a "developer journey"—you can follow the 3 main steps, or jump directly to any capability.

The 3-Step Path from Zero to Listing

Create an App

Register an account on the Partner Center, create a public or private app, configure redirect URLs and access scopes.

Integrate API & Webhook

Run through OAuth installation, call Open APIs, subscribe to events, and verify signatures.

Test & Submit for Review

Run test cases, perform self-checks against review requirements, and submit to the App Store for review.

1. Getting started

Register a partner account, create an app, choose the app type, and start local development with the Shoplazza CLI.

Partner Registration

Activate a developer account and join the partner program.

App Type Selection

Differences and use cases for public, private, payment, and embedded apps.

Create a Public App

Apps for the App Store with full OAuth installation and review process.

Create a Private App

Apps for a single store, bypassing the App Store listing.

Create a Payment App

Build an independent payment service to integrate with the Shoplazza payment flow.

Shoplazza CLI Hands-on

Use the shoplazza app command for scaffolding, local development, and deployment.

2. Core Capabilities

Jump to whichever you need. If you're building your first app, do Authentication first — every REST API and Webhook call depends on having an Access Token.

OAuth Authentication

Installation, Access Token, and Refresh Token for public apps.

Access Scopes

Request, change, and re-authorize scopes.

HMAC Signature Verification

Unified reference for signature algorithms in OAuth callback, Webhook, etc.

API Reference Overview

Call conventions, error codes, ID specifications, and other cross-cutting mechanisms.

Webhook

Concepts, subscription, signature, retry, and event list.

App Proxy

Proxy a storefront URL path to your app backend.

App Bridge

SDK and Session Token for embedded admin apps.

Billing API

One-time charges, subscriptions, and usage-based billing.

API Client Libraries

Official SDKs and examples for various languages.

3. Extension Development

Embed app capabilities into store touchpoints such as themes and checkout—see each extension's dedicated section for details.

Theme Extensions

Add App Blocks / App Embed Blocks to online stores.

Checkout Extensions

Insert custom UI and logic into the checkout and thank-you page.

4. Launch

Test, submit for review, list, and operate.

Test Your App

Debug locally with a test store.

App Guidelines

Review criteria for functionality, performance, security, and privacy.

Review Process

Submission, common rejection reasons, and re-review.

Post-launch Operations

Support, marketing, and user feedback.

Frequently Asked Questions

Common Q&A during development and listing.