USusenash
Inventory

Sync store inventory catalogs to SFTP

Changed on

Trigger a full catalog export+upload for all synced stores (all: true) or a specific list of store external ids. Returns the run activity id; per-store export runs asynchronously.

post/v1/inventory/sync

Request

Request body

allboolean

Sync every store configured for SFTP catalog sync in this org.

store_external_idsstring[] nullable

Explicit store external ids to sync. Mutually exclusive with all; exactly one is required.

Response

OK

run_activity_idstring required
planned_storesinteger required
unknown_store_external_idsstring[]

Requested store external ids that aren't configured for SFTP catalog sync (skipped, not synced).

Changes