DOCSEARCHbyAlgolia
Submit Docs

Shoplazza App Development Documentation

website·Indexed 32 days ago

https://dev.shoplazza.dev

Developer guides and API references for building Shoplazza apps. Includes documentation on the REST API, OAuth 2.0 authentication, HMAC signature verification, webhooks, app billing, App Proxy, and best practices for security, performance, and accessibility.

Tokens
253.1K
Snippets
1.2K
Records
1.8K
Agent score
49%

What's inside Shoplazza

  1. Overview of the Order API

    The Order API enables storefront JavaScript to read and act on orders. For security, every endpoint that requires an order ID requires a signed-in customer and only grants access to that customer's own orders. The only exception is the POST /{locale}/api/order_verify endpoint, which allows anonymous visitors to trade an order number and email address for the order page address. All requests should use locale-aware URLs and include an X-CSRF-Token header.

  2. Overview of Shoplazza CLI v2

    Shoplazza CLI is a command-line tool used for the full development lifecycle of Shoplazza apps, themes, and extensions. Version 2 introduces a three-layer command system, OAuth 2.0 authentication, and structured output formats designed for both developers and AI agents.

  3. Overview of the Shoplazza Admin REST API

    The Shoplazza Admin API is a REST-based interface that allows developers to read and write merchant data, including stores, products, and orders. It is used to integrate Shoplazza with external systems and to add custom features to the Shoplazza admin store-management interface.

  4. Overview of the Shoplazza Theme Editor

    The Shoplazza theme editor is a tool that allows merchants to customize the content and appearance of their store and preview changes in real-time. Theme developers can enable these customizations by introducing settings and dividing theme functionality into modular sections and blocks.

  5. Overview of Shoplazza Theme storefront capabilities

    Shoplazza Themes support a variety of storefront capabilities designed to meet merchant needs for business operations and customer experience. Key feature areas include:

    • Product merchandising
    • Pricing and payments
    • Navigation and search
    • SEO (Search Engine Optimization)
    • Custom data management
    • Tracking and analytics

  6. Overview of the Shoplazza Ajax API

    The Shoplazza Ajax API provides lightweight REST API endpoints specifically for the development of Shoplazza themes. It allows storefront JavaScript to perform tasks such as updating the cart, displaying product recommendations, managing customer profiles, and reading metafields. Note that the Ajax API can only be used by themes hosted by Shoplazza.

  7. Overview of the Shoplazza App development lifecycle

    Developing a Shoplazza app follows a four-stage journey from initial setup to listing on the app store. Shoplazza apps can extend the admin panel, the online store, the checkout flow, and backend services.

    The development path consists of:

    1. Getting Started: Registering a partner account, creating the app, selecting the app type, and setting up local development using the Shoplazza CLI.
    2. Core Capabilities: Implementing essential backend logic. Authentication is the critical first step, as all REST API and Webhook calls require an Access Token.
    3. Extension Development: Embedding app functionality into specific store touchpoints, such as themes and the checkout process.
    4. Launch: Testing the application, submitting it for review, listing it, and managing operations.

  8. Overview of Shoplazza OAuth 2.0 Flow

    Public Shoplazza apps use the OAuth 2.0 authorization code flow to obtain an Access Token from a store. The high-level sequence is:

    1. Shoplazza calls the app's configured URL with HMAC, shop, and store_id.
    2. The app validates the HMAC, generates a state, and redirects the merchant to the Shoplazza authorization page.
    3. The merchant approves the requested scopes.
    4. Shoplazza redirects back to the app's redirect_uri with a one-time authorization code, state, and HMAC.
    5. The app validates the state and HMAC, then exchanges the code for an access token.
    6. The app persists the token and uses it in the Access-Token header for Open API calls.

  9. Overview of Shoplazza Public vs Private Apps

    Shoplazza supports two main categories of apps: Public Apps and Private Apps. Public apps are distributed via the Shoplazza App Store and can be installed by multiple merchants. Private apps are unique to a single store, are created within that store's admin, and do not appear in the App Store.

  10. Overview of Shoplazza AI Toolkit Agent Skills

    Agent Skills are SKILL.md guidance files, organized by domain, that teach an AI agent which commands to run for specific tasks, including the relevant fields, boundaries, and safety rules. While the Shoplazza CLI functions without them, installing these skills significantly increases the agent's accuracy when performing store operations.

  11. Overview of Shoplazza Webhooks

    Webhooks allow Shoplazza apps to passively receive store events (e.g., order creation, product updates, app uninstalls) via HTTP POST requests sent to a pre-registered URL. For a webhook to function, the merchant must have installed the app and the app must have subscribed to a specific event topic at a specific API version.

  12. Overview of Shoplazza AI Toolkit

    The Shoplazza AI Toolkit allows AI coding agents to operate the Shoplazza platform using natural language. It uses the Shoplazza CLI as an agent-native execution engine, where every command returns structured JSON, enabling agents to manage products, discounts, orders, and customers without additional setup.