ZingaShop API v1

The ZingaShop (commerce) endpoints of the Zingasuite API. Authenticate with a zk_ key carrying data:read / data:write:* scopes. All amounts are integer cents; ids are UUID strings. Paste a key below and try any endpoint live.

Products

List, read, create and update catalog products.

GET/productsList products

Returns a paginated list. Search with q; scope/price with websiteId.

NameInTypeReqDescription
limitqueryintegerPage size (1-200, default 50)
offsetqueryintegerRows to skip
qquerystringSearch by name / SKU
websiteIdquerystringScope to a storefront (and its currency)
Trial
GET/products/{id}Get a product
Pass websiteId to price in that storefront's currency.
NameInTypeReqDescription
idpathstringyesProduct id
websiteIdquerystringScope to a storefront (and its currency)
Trial
POST/productsCreate a product
name is required. type: simple|configurable|bundle|digital|subscription|gift_card.
Trial
PATCH/products/{id}Update a product
Updatable: name, status, code, priceCents, currency.
NameInTypeReqDescription
idpathstringyesProduct id
Trial
Categories
The nested catalog category tree.
GET/categoriesList categories
Returns the full tree with path and depth.
Trial
POST/categoriesCreate a category
name required; slug must be unique among siblings.
Trial
PATCH/categories/{id}Update a category
Updatable: name, sortOrder, isActive.
NameInTypeReqDescription
idpathstringyesCategory id
Trial
Inventory
Read and adjust stock per variant across warehouses.
GET/variants/{variant_id}/inventoryRead stock levels
NameInTypeReqDescription
variant_idpathstringyesVariant id
Trial
POST/inventory/adjustAdjust stock
Identify by variantId/sku + warehouseId/warehouseCode; send setOnHand or deltaOnHand.
Trial
Orders
List, read and create orders.
GET/ordersList orders
NameInTypeReqDescription
limitqueryintegerPage size (1-200, default 50)
offsetqueryintegerRows to skip
Trial
GET/orders/{id}Get an order
NameInTypeReqDescription
idpathstringyesOrder id
Trial
POST/ordersCreate an order
Bring in a sale from an external channel. websiteId, currency, customer, items required.
Trial
Storefronts
Your websites and their currency/locale settings.
GET/websitesList storefronts
Use a storefront id as websiteId elsewhere.
Trial
Pricing
Per-variant prices, compare-at prices and quantity tiers.
PATCH/variants/{variant_id}/pricesSet variant prices
Each entry targets a currency or pricelistId and sets priceCents (offer) with optional compareAtCents (standard), OR a tiers ladder.
NameInTypeReqDescription
variant_idpathstringyesVariant id
Trial
Catalog & store resources
A uniform CRUD layer over ~30 more objects. Set the `resource` path parameter to one of: tags, collections, attribute-sets, attributes, brands, currencies, languages, tax-zones, tax-rates, customers, customer-groups, reviews, promotions, coupons, gift-cards, cms-pages, blog-categories, blog-posts, banners, menus, pricelists, subscription-plans, subscriptions, digital-assets, entitlements, warehouses, returns, shipping-zones, shipping-methods, search-synonyms, search-redirects, url-redirects, carrier-integrations, payment-gateways. (products, orders, inventory and websites use their dedicated endpoints.)
GET/{resource}List a resource
NameInTypeReqDescription
resourcepathstringyesResource key
limitqueryintegerPage size (1-200, default 50)
offsetqueryintegerRows to skip
qquerystringFree-text search
Trial
GET/{resource}/{id}Read one row
NameInTypeReqDescription
resourcepathstringyesResource key
idpathstringyesRow id
Trial
POST/{resource}Create a row
Fields mirror a row's readable fields. Returns 405 for read-only resources.
NameInTypeReqDescription
resourcepathstringyesResource key
Trial
PATCH/{resource}/{id}Update a row
NameInTypeReqDescription
resourcepathstringyesResource key
idpathstringyesRow id
Trial
DELETE/{resource}/{id}Delete a row
NameInTypeReqDescription
resourcepathstringyesResource key
idpathstringyesRow id
Trial
Sales channels
Trigger Google Merchant / Meta Commerce catalog syncs per storefront.
GET/websites/{website_id}/google-merchantGoogle Merchant status
NameInTypeReqDescription
website_idpathstringyesStorefront id
Trial
POST/websites/{website_id}/google-merchant/syncSync to Google Merchant
NameInTypeReqDescription
website_idpathstringyesStorefront id
fullquerybooleanFull re-sync vs changes only
backgroundquerybooleanQueue vs run inline
Trial
GET/websites/{website_id}/meta-commerceMeta Commerce status
NameInTypeReqDescription
website_idpathstringyesStorefront id
Trial
POST/websites/{website_id}/meta-commerce/syncSync to Meta Commerce
NameInTypeReqDescription
website_idpathstringyesStorefront id
fullquerybooleanFull re-sync vs changes only
backgroundquerybooleanQueue vs run inline
Trial
← All APIs