Commerce

Sync a store into a Meta catalog

Keeps a Meta product catalog in sync with the store, for catalog ads (goal: catalog_sales) and Shops. The first full run starts right away in the background; runStatus and the item counts report its outcome. Every active product variant that is published to the online store and has an image becomes a catalog item, grouped by product (item_group_id). After that, product changes on the store update the catalog within minutes, and a daily full run removes items for products or variants the store no longer has. Items are namespaced to the store, so a catalog can take several stores and a run never touches items it did not create.

catalogAccountId is a connected facebook, instagram or metaads account whose Meta login can manage the catalog (the catalog_management permission); find catalogs with GET /v1/ads/catalogs.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/commerce/catalog-syncs

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/commerce/catalog-syncs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

accountIdstring required

The store SocialAccount id.

catalogIdstring required

Meta product catalog id.

catalogAccountIdstring required

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.