Commerce · Commerce

Run a catalog sync now

Runs a catalog sync now. Works with Shopify and WooCommerce accounts.

POSThttps://api.pozy.ai/v1/commerce/catalog-syncs/{syncId}/run

Shopify and WooCommercerunCommerceCatalogSync

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

Path parameters

Name	Type	Notes
`syncId`required	string

Example

curl -X POST "https://api.pozy.ai/v1/commerce/catalog-syncs/63ca7257048d6984dff0f88f/run" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/commerce/catalog-syncs/63ca7257048d6984dff0f88f/run", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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/63ca7257048d6984dff0f88f/run",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

202 on success

catalogSyncobject
13 child fields
- idstring
- accountIdstring
- catalogPlatformstring
  One of meta.
- catalogAccountIdstring
- catalogIdstring
- runStatusstring
  One of pending, running, succeeded, failed.
- lastRunStartedAtstring (date-time)
  Can be null.
- lastRunFinishedAtstring (date-time)
  Can be null.
- lastErrorstring
  Can be null.
- itemsSentinteger
- itemsSkippedinteger
- itemsDeletedinteger
- createdAtstring (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.
404	not_found	Nothing with that id exists in your workspace.
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 store GETList orders GETGet an order GETList products POSTCreate a product POSTActivate, deactivate, archive or delete products GETGet a product PATCHUpdate a product POSTUpdate variant prices GETList collections POSTCreate a collection GETGet a collection PATCHUpdate a collection DELDelete a collection POSTAdd or remove products in a collection POSTAdd variants DELDelete variants POSTAdd options DELDelete options POSTAdd images DELRemove images POSTReorder images POSTDuplicate a product GETList product metafields PUTSet product metafields DELDelete product metafields POSTPublish or unpublish a product GETList collection metafields PUTSet collection metafields DELDelete collection metafields POSTPublish or unpublish a collection POSTAdd or remove tags in bulk POSTReorder products in a collection GETList pages POSTCreate a page GETGet a page PATCHUpdate a page DELDelete a page GETList locations GETGet a product's stock POSTSet or adjust stock GETList sales channels GETList discounts POSTCreate a discount GETGet a discount PATCHUpdate a discount DELDelete a discount POSTActivate or deactivate a discount POSTAdd codes to a discount GETList URL redirects POSTCreate a URL redirect PATCHUpdate a URL redirect DELDelete a URL redirect GETList navigation menus POSTCreate a navigation menu GETGet a navigation menu PUTReplace a navigation menu DELDelete a navigation menu GETList metaobject definitions GETList metaobjects of a type POSTCreate a metaobject GETGet a metaobject PATCHUpdate a metaobject DELDelete a metaobject GETList markets GETList price lists PUTSet fixed prices DELRemove fixed prices PUTRecord a marketing activity DELDelete a marketing activity POSTReport daily engagement GETList catalog syncs POSTSync a store into a Meta catalog GETGet a catalog sync DELStop a catalog sync