ZingaShopSign in

ZingaShop API

ZingaShop API

These are the ZingaShop endpoints of the Zingasuite API — the commerce surface
that lets your own code manage the catalog, pricing, stock, orders and
storefront configuration you also manage in the console. Use them to build
integrations, sync an ERP or point-of-sale system, and automate merchandising.

Access

Every request needs a zk_ API key sent as a bearer token. For the ZingaShop
endpoints, grant the key the data scopes:

  • data:read — read any object your role can read.
  • data:write:* — create, update and delete any object your role can write
    (the API also enforces a granular per-object scope such as
    data:write:products, which data:write:* satisfies).

The base URL is:

https://api-v1.zingasuite.com/papi/v1

Sections

  • Products — list, read, create and update products,
    variants and media.
  • Categories — the nested category tree.
  • Inventory — read and adjust stock across
    warehouses.
  • Orders — list, read and create orders.
  • Storefronts — your websites and their
    currency/locale settings.
  • Pricing — per-variant flat prices, compare-at prices
    and quantity-break tiers.
  • Catalog & store resources — the generic
    list/read/create/update/delete layer covering ~30 additional catalog,
    marketing, shipping and store-configuration objects.
  • Sales channels — trigger Google Merchant and
    Meta Commerce catalog syncs.

Shared rules

The conventions that apply to every Zingasuite endpoint — how keys work, request
and response shapes, error codes and rate limits — live in the Developer API
chapter:

You can try any of these endpoints live, with your own key, in the interactive
explorer at /_solve/api.

Was this helpful?