Skip to main content
POST
Create collections export

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Body

application/json

Request body for an async collection export job.

collectionId
string
required

Collection identifier.

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"abcdef12"

catalog
enum<string>
default:marketplace
required

Product catalog to export from (marketplace | swag).

Available options:
marketplace,
swag
Example:

"marketplace"

locations
string[]
required

ISO 3166-1 alpha-2 country codes used for price localisation.

Minimum array length: 1
Pattern: ^[A-Z]{2}$
Example:
format
enum<string>
default:ndjson

Output file format. Async export is NDJSON-only.

Available options:
ndjson
Example:

"ndjson"

Response

Export job accepted (200 OK). Poll the returned exportId via GET /v3/products/exports/{exportId}.

Export job accepted. The job runs in the background; poll GET /v3/products/exports/{exportId} for status.

exportId
string
required

Export job identifier. Poll GET /v3/products/exports/{exportId} until the job reaches a terminal state.

Example:

"6650a1b2c3d4e5f6a7b8c9d0"

Last modified on July 9, 2026