Create collection export job (async)

curl --request POST \
  --url https://api.snappy.com/public-api/v3/collections/exports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "collectionId": "abcdef12",
  "catalog": "marketplace",
  "locations": [
    "US"
  ],
  "format": "ndjson"
}
'

{
  "exportId": "6650a1b2c3d4e5f6a7b8c9d0"
}

Export (coming soon)

Create collections export job

Use this endpoint to kick off a background export job for all products in a single collection. Returns an exportId to poll.

Required fields:

collectionId - the collection to export.
catalog - product catalog. One of marketplace or swag.
locations - array of ISO 3166-1 alpha-2 country codes for price localisation.

Optional fields:

format - output file format. Currently ndjson only; defaults to ndjson.

Optional headers:

Snappy-Account-Id - optional account scoping.
Snappy-Company-Id - optional company scoping.

Behavior notes:

Returns 200 OK immediately with an exportId. The job runs in the background.
Poll GET /v3/products/exports/{exportId} until the job reaches a terminal state (completed or failed). On completion, the status response includes a downloadUrls map of signed URLs (keyed by file identifier or location code).
The export record expires 48 hours after creation. Download the file(s) before that - expired records cannot be re-issued; you’ll need to create a new export job.
Returns 404 if the supplied collectionId does not exist.

Permissions

Requires: products:read

POST

collections

exports

Create collection export job (async)

curl --request POST \
  --url https://api.snappy.com/public-api/v3/collections/exports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "collectionId": "abcdef12",
  "catalog": "marketplace",
  "locations": [
    "US"
  ],
  "format": "ndjson"
}
'

{
  "exportId": "6650a1b2c3d4e5f6a7b8c9d0"
}

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

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

X-Api-Key: YOUR_API_KEY

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:

["US"]

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 June 17, 2026

Create products export job

Poll export job status