Poll export job status

curl --request GET \
  --url https://api.snappy.com/public-api/v3/products/exports/{exportId} \
  --header 'X-Api-Key: <api-key>'

{
  "status": "pending"
}

Export (coming soon)

Poll export job status

Use this endpoint to check the status of an asynchronous export job. Poll this endpoint after calling POST /v3/products/exports or POST /v3/collections/exports until the job reaches a terminal state (completed or failed).

Required parameters:

exportId - the export job identifier returned from the create call, passed as a path parameter.

Please note:

Status transitions: pending → processing → completed | failed.
When status is completed, the response includes a downloadUrls map of signed URLs keyed by file identifier (e.g. "0") or location code (e.g. "US"). Download the file(s) before the export record expires (48 hours after creation).
When status is failed, the response includes an errorMessage describing the failure (e.g. "Export timed out").
The same poll endpoint serves both product export jobs and collection export jobs - exportId is sufficient to look up either.
Returns 404 if the supplied exportId does not exist or the export record has expired.

Permissions

Requires: products:read

GET

products

exports

{exportId}

Poll export job status

curl --request GET \
  --url https://api.snappy.com/public-api/v3/products/exports/{exportId} \
  --header 'X-Api-Key: <api-key>'

{
  "status": "pending"
}

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"

Path Parameters

exportId

string

required

Export job identifier returned from POST /v3/products/exports.

Minimum string length: 1

Example:

"6650a1b2c3d4e5f6a7b8c9d0"

Response

Export job status.

Status of an asynchronous export job. When completed, includes signed downloadUrls; when failed, includes errorMessage.

status

enum<string>

required

Current export job state. Transitions: pending → processing → completed | failed.

Available options:

pending,

processing,

completed,

failed

downloadUrls

object

Present only when status is completed. Map of signed download URLs keyed by file identifier (e.g. "0") or location code (e.g. "US"). Download before the export record expires (48 hours).

Show child attributes

errorMessage

string

Present only when status is failed. Human-readable failure reason (e.g. "Export timed out").

Last modified on June 17, 2026

Create collections export job

Swag Products: Branded Merchandise Templates