Overview

Shoplazza Admin API

As the primary way that apps and services interact with Shoplazza, the Admin API allows you to add your own features to the Shoplazza user experience. Considerations when using the Shoplazza Admin include:

  • The Admin API supports REST API.
  • This is a versioned API. Updates are released every half year.
  • Apps must explicitly request the relevant access scopes from merchants during installation.
  • Apps must authenticate to interact with the Admin API.
  • The Admin API enforces rate limits on all requests. Note that there are rate-limiting REST API. All apps and services connecting to the Admin API are subject to Shoplazza's API Terms of Service.

Get Started

Getting started with REST Admin APIs - Learn how to authenticate with the REST Admin APIs and start sending requests.

Working with the Shoplazza Admin API

  • Read and write Shoplazza store information, including products, inventory, orders, shipping, and more.
  • Extend existing Shoplazza functionality with apps.
  • Connect store inventory to other marketplaces with channels.

Reference documentation

  • Order — Give merchants new ways to receive, process, and manage their orders.
  • Fulfillment — Show custom shipping rates at checkout, or register your app as a store's fulfillment service and then manage its fulfillments.
  • Product — Access and manipulate a store's catalog using product and collection APIs.
  • Customer — Help merchants manage their customer data.
  • Customer Session — Help merchants manage their customers' Login/Logout session.
  • Webhook— Fetch event data or register webhooks to keep your app synced with the merchant store.
  • Online Store — Update a merchant's online storefront and its content.
  • Shop Details — Manage a store's configuration.
  • App Proxy — Manage app proxy configuration
  • Discounts — Help merchants to offer flexible discounts.
  • Metafield — Add metadata to store resources.
  • Data — Fetch event data or register webhooks to keep your app synced with the merchant store.