Commerce & blogs

Stores and websites are accounts too. Connect a Shopify store, a WooCommerce shop or a WordPress, Wix or Webflow site to a profile, and you can manage its catalog, read its orders, publish its blog and put ad pixels on it, with the same API key and request shapes you use for social posting. Write the integration once and it works on every platform that supports the job.

#What each platform supports

WooCommerce is not a separate connection: it is a self-hosted WordPress site with WooCommerce installed, connected with an Application Password. Store objects from it report platform: "woocommerce".

#Two APIs, one account

• Commerce API at /v1/commerce/... covers the catalog, stock, orders, discounts and store content. Every call names the store with accountId: in the query on reads, in the body on writes. See Products and Orders.
• Blogs API at /v1/accounts/{accountId}/blogs/... publishes articles. The same five calls work on Shopify, WordPress, Wix and Webflow. See Blogs.

Ad pixels use the tracking tag endpoints of your ads account and name the site as storeAccountId. See Site pixels.

#Start with the store's capabilities

Call GET /v1/commerce/store before anything else. It tells you the currency and country, what the store can do now, and what it could do once the owner grants more permissions.

curl "https://api.pozy.ai/v1/commerce/store?accountId=6710c4b2e4b0d2f1a8c95e3a" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/commerce/store?accountId=6710c4b2e4b0d2f1a8c95e3a", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error);

if (data.store.missingCapabilities.includes("orders.read")) {
  console.log("Ask the owner to approve:", data.store.grantPermissionsUrl);
}

import os, requests

store = requests.get(
    "https://api.pozy.ai/v1/commerce/store",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={"accountId": "6710c4b2e4b0d2f1a8c95e3a"},
).json()["store"]

print(store["capabilities"], store["grantPermissionsUrl"])

{
  "store": {
    "accountId": "6710c4b2e4b0d2f1a8c95e3a",
    "platform": "shopify",
    "name": "Acme",
    "domain": "acme.myshopify.com",
    "url": "https://acme.com",
    "currency": "USD",
    "country": "US",
    "capabilities": ["products.read", "products.create", "products.update", "collections.read", "pages.read", "pages.write"],
    "missingCapabilities": ["inventory.read", "inventory.write", "discounts.read", "orders.read"],
    "grantPermissionsUrl": "https://admin.shopify.com/store/acme/oauth/install?..."
  }
}

On Shopify, send the owner to grantPermissionsUrl to approve the missing capabilities on the existing install, then read the store again. grantPermissionsUrl is null when nothing is missing, on stores connected with a custom-app token, and always on WooCommerce. The capability-to-scope table is on the Shopify page.

#Shared conventions

#Errors

#In this section

#Endpoints

#Webhook events