---
title: "Sync store inventory catalogs to SFTP"
method: POST
path: "/v1/inventory/sync"
tags: ["Inventory"]
---

# Sync store inventory catalogs to SFTP

`POST /v1/inventory/sync`

## Request

- Base URL: `https://api.sandbox.usenash.com`
- URL: `https://api.sandbox.usenash.com/v1/inventory/sync`
- Auth: none declared

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.

## Request body

- InventorySyncRequest
  - `all` boolean: Sync every store configured for SFTP catalog sync in this org.
  - `store_external_ids` string[], nullable: Explicit store external ids to sync. Mutually exclusive with `all`; exactly one is required.

## Response `200`

OK

- InventorySyncResponse
  - `run_activity_id` string, required
  - `planned_stores` integer, required
  - `unknown_store_external_ids` string[]: Requested store external ids that aren't configured for SFTP catalog sync (skipped, not synced).

## Other responses

- `422`: Unprocessable Content

---

[API](https://skmtc.dev/nash/apis/nash-api.md) - [All operations](https://skmtc.dev/nash/apis/nash-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nash/apis/nash-api/revisions/e3713837c5c9?raw)