Skip to main content
POST
Create collections export
Required fields:
  • collectionId - the collection to export.
  • catalog - product catalog. One of marketplace, swag, giftCards, or donations.
  • 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.
  • fields - computed / expanded fields. Currently supports ranking. Include ranking to add Snappy’s per-country catalog-ranking score (0-100, higher is stronger) to each product in the exported file. The score represents the product’s general standing within each country’s catalog and is independent of your filters or collection context. Does not represent search relevance or position in the response.
Optional headers:
  • Snappy-Account-Id - optional account 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 exported NDJSON file contains one product per line, each with its full variant list and per-country availability. See NDJSON export format for the full shape.
  • 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

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

Must be provided to retrieve swag products.

Example:

"acc123456"

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 | giftCards | donations).

Available options:
marketplace,
swag,
giftCards,
donations
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 data.exportId via GET /v3/products/exports/{exportId}.

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

data
object
required
Last modified on September 18, 2026