Commerce · Commerce
Syncs a store into a Meta catalog. Works with Shopify and WooCommerce accounts.
POST
https://api.pozy.ai/v1/commerce/catalog-syncsShopify and WooCommercecreateCommerceCatalogSync
Guides: Products and catalog, Commerce & blogs
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
accountIdstringrequiredcatalogAccountIdstringrequiredcatalogIdstringrequiredMatches
^\d+$.
Example
curl -X POST "https://api.pozy.ai/v1/commerce/catalog-syncs" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"catalogAccountId": "6ff8c3c33fde58e5348d37b7",
"catalogId": "6f2f2ffcf4ace3659342c4c2"
}'const res = await fetch("https://api.pozy.ai/v1/commerce/catalog-syncs", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
catalogAccountId: "6ff8c3c33fde58e5348d37b7",
catalogId: "6f2f2ffcf4ace3659342c4c2"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/commerce/catalog-syncs",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"catalogAccountId": "6ff8c3c33fde58e5348d37b7",
"catalogId": "6f2f2ffcf4ace3659342c4c2",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
202 on success
catalogSyncobject13 child fields
idstringaccountIdstringcatalogPlatformstringOne of
meta.catalogAccountIdstringcatalogIdstringrunStatusstringOne of
pending,running,succeeded,failed.lastRunStartedAtstring (date-time)Can be null.
lastRunFinishedAtstring (date-time)Can be null.
lastErrorstringCan be null.
itemsSentintegeritemsSkippedintegeritemsDeletedintegercreatedAtstring (date-time)
202 response
{
"catalogSync": {
"id": "6bfebd43ddc270f6d2c56fc5",
"accountId": "696e0b682d0a31188e7a2ba9",
"catalogPlatform": "meta",
"catalogAccountId": "6ff8c3c33fde58e5348d37b7",
"catalogId": "6f2f2ffcf4ace3659342c4c2",
"runStatus": "pending",
"lastRunStartedAt": "2026-10-02T09:00:00.000Z",
"lastRunFinishedAt": "2026-10-02T09:00:00.000Z",
"lastError": "string",
"itemsSent": 1,
"itemsSkipped": 1,
"itemsDeleted": 1,
"createdAt": "2026-10-02T09:00:00.000Z"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Commerce
GETGet a storeGETList ordersGETGet an orderGETList productsPOSTCreate a productPOSTActivate, deactivate, archive or delete productsGETGet a productPATCHUpdate a productPOSTUpdate variant pricesGETList collectionsPOSTCreate a collectionGETGet a collectionPATCHUpdate a collectionDELDelete a collectionPOSTAdd or remove products in a collectionPOSTAdd variantsDELDelete variantsPOSTAdd optionsDELDelete optionsPOSTAdd imagesDELRemove imagesPOSTReorder imagesPOSTDuplicate a productGETList product metafieldsPUTSet product metafieldsDELDelete product metafieldsPOSTPublish or unpublish a productGETList collection metafieldsPUTSet collection metafieldsDELDelete collection metafieldsPOSTPublish or unpublish a collectionPOSTAdd or remove tags in bulkPOSTReorder products in a collectionGETList pagesPOSTCreate a pageGETGet a pagePATCHUpdate a pageDELDelete a pageGETList locationsGETGet a product's stockPOSTSet or adjust stockGETList sales channelsGETList discountsPOSTCreate a discountGETGet a discountPATCHUpdate a discountDELDelete a discountPOSTActivate or deactivate a discountPOSTAdd codes to a discountGETList URL redirectsPOSTCreate a URL redirectPATCHUpdate a URL redirectDELDelete a URL redirectGETList navigation menusPOSTCreate a navigation menuGETGet a navigation menuPUTReplace a navigation menuDELDelete a navigation menuGETList metaobject definitionsGETList metaobjects of a typePOSTCreate a metaobjectGETGet a metaobjectPATCHUpdate a metaobjectDELDelete a metaobjectGETList marketsGETList price listsPUTSet fixed pricesDELRemove fixed pricesPUTRecord a marketing activityDELDelete a marketing activityPOSTReport daily engagementGETList catalog syncsGETGet a catalog syncDELStop a catalog syncPOSTRun a catalog sync now