Create products export

curl --request POST \
  --url https://api.snappy.com/public-api/v3/products/exports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "catalog": "marketplace",
  "format": "ndjson",
  "search": "<string>",
  "type": "physical",
  "brandName": "<string>",
  "brandId": [
    "<string>"
  ],
  "tagId": [
    "<string>"
  ],
  "price": {
    "gte": 1,
    "lte": 1
  },
  "productIds": [
    "<string>"
  ],
  "locations": [
    "US"
  ],
  "include": [
    "brand",
    "tags"
  ],
  "fields": [
    "priceRange",
    "variantsCount"
  ]
}
'

import requests

url = "https://api.snappy.com/public-api/v3/products/exports"

payload = {
    "catalog": "marketplace",
    "format": "ndjson",
    "search": "<string>",
    "type": "physical",
    "brandName": "<string>",
    "brandId": ["<string>"],
    "tagId": ["<string>"],
    "price": {
        "gte": 1,
        "lte": 1
    },
    "productIds": ["<string>"],
    "locations": ["US"],
    "include": ["brand", "tags"],
    "fields": ["priceRange", "variantsCount"]
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    catalog: 'marketplace',
    format: 'ndjson',
    search: '<string>',
    type: 'physical',
    brandName: '<string>',
    brandId: ['<string>'],
    tagId: ['<string>'],
    price: {gte: 1, lte: 1},
    productIds: ['<string>'],
    locations: ['US'],
    include: ['brand', 'tags'],
    fields: ['priceRange', 'variantsCount']
  })
};

fetch('https://api.snappy.com/public-api/v3/products/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v3/products/exports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'catalog' => 'marketplace',
    'format' => 'ndjson',
    'search' => '<string>',
    'type' => 'physical',
    'brandName' => '<string>',
    'brandId' => [
        '<string>'
    ],
    'tagId' => [
        '<string>'
    ],
    'price' => [
        'gte' => 1,
        'lte' => 1
    ],
    'productIds' => [
        '<string>'
    ],
    'locations' => [
        'US'
    ],
    'include' => [
        'brand',
        'tags'
    ],
    'fields' => [
        'priceRange',
        'variantsCount'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v3/products/exports"

	payload := strings.NewReader("{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.snappy.com/public-api/v3/products/exports")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v3/products/exports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "exportId": "6650a1b2c3d4e5f6a7b8c9d0"
}

{
  "message": "Request validation failed.",
  "errorCode": "400_PBLC_001"
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

Export

Create products export

Use this endpoint to kick off a background product export job. Use this when the synchronous list endpoints would require many paginated requests, or when you’d rather fire-and-forget the export and poll for completion later.

Required fields:

catalog - product catalog to export from. One of marketplace or swag.
format - output file format. Currently ndjson only.

Optional filters:

search - free-text search filter.
type - product type. One of physical, digital, giftCard, donation.
brandName - filter by brand name.
brandId - array of brand IDs.
tagId - array of tag IDs.
productIds - array of specific product IDs to export (max 100).
price.gte / price.lte - inclusive price range (flat body fields; see note below).
locations - ISO 3166-1 alpha-2 country codes for price localisation (default ["US"]).

Optional response shaping:

include - related entities to include. One or more of brand, tags.
fields - computed / expanded fields. One or more of priceRange, variantsCount, total.

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.
Body-level price filters use flat price.gte / price.lte fields rather than the nested filter[price][gte] / filter[price][lte] form used in query strings on V3 list endpoints. Same semantics, different ergonomic surface.

Permissions

Requires: products:read

POST

products

exports

Create products export

curl --request POST \
  --url https://api.snappy.com/public-api/v3/products/exports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "catalog": "marketplace",
  "format": "ndjson",
  "search": "<string>",
  "type": "physical",
  "brandName": "<string>",
  "brandId": [
    "<string>"
  ],
  "tagId": [
    "<string>"
  ],
  "price": {
    "gte": 1,
    "lte": 1
  },
  "productIds": [
    "<string>"
  ],
  "locations": [
    "US"
  ],
  "include": [
    "brand",
    "tags"
  ],
  "fields": [
    "priceRange",
    "variantsCount"
  ]
}
'

import requests

url = "https://api.snappy.com/public-api/v3/products/exports"

payload = {
    "catalog": "marketplace",
    "format": "ndjson",
    "search": "<string>",
    "type": "physical",
    "brandName": "<string>",
    "brandId": ["<string>"],
    "tagId": ["<string>"],
    "price": {
        "gte": 1,
        "lte": 1
    },
    "productIds": ["<string>"],
    "locations": ["US"],
    "include": ["brand", "tags"],
    "fields": ["priceRange", "variantsCount"]
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    catalog: 'marketplace',
    format: 'ndjson',
    search: '<string>',
    type: 'physical',
    brandName: '<string>',
    brandId: ['<string>'],
    tagId: ['<string>'],
    price: {gte: 1, lte: 1},
    productIds: ['<string>'],
    locations: ['US'],
    include: ['brand', 'tags'],
    fields: ['priceRange', 'variantsCount']
  })
};

fetch('https://api.snappy.com/public-api/v3/products/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v3/products/exports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'catalog' => 'marketplace',
    'format' => 'ndjson',
    'search' => '<string>',
    'type' => 'physical',
    'brandName' => '<string>',
    'brandId' => [
        '<string>'
    ],
    'tagId' => [
        '<string>'
    ],
    'price' => [
        'gte' => 1,
        'lte' => 1
    ],
    'productIds' => [
        '<string>'
    ],
    'locations' => [
        'US'
    ],
    'include' => [
        'brand',
        'tags'
    ],
    'fields' => [
        'priceRange',
        'variantsCount'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v3/products/exports"

	payload := strings.NewReader("{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.snappy.com/public-api/v3/products/exports")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v3/products/exports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"catalog\": \"marketplace\",\n  \"format\": \"ndjson\",\n  \"search\": \"<string>\",\n  \"type\": \"physical\",\n  \"brandName\": \"<string>\",\n  \"brandId\": [\n    \"<string>\"\n  ],\n  \"tagId\": [\n    \"<string>\"\n  ],\n  \"price\": {\n    \"gte\": 1,\n    \"lte\": 1\n  },\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"locations\": [\n    \"US\"\n  ],\n  \"include\": [\n    \"brand\",\n    \"tags\"\n  ],\n  \"fields\": [\n    \"priceRange\",\n    \"variantsCount\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "exportId": "6650a1b2c3d4e5f6a7b8c9d0"
}

{
  "message": "Request validation failed.",
  "errorCode": "400_PBLC_001"
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

{
  "message": "Product not found.",
  "errorCode": "404_PROD_001",
  "errors": [
    {
      "message": "Product with id 'q1w2e3r4t5' was not found",
      "path": "pathParameters.productId",
      "errorCode": "404_PROD_001"
    }
  ]
}

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 export job. Price filters use flat body fields rather than query-string filter[price][...] syntax.

catalog

enum<string>

default:marketplace

required

Product catalog to export from (marketplace | swag).

Available options:

marketplace,

swag

Example:

"marketplace"

format

enum<string>

required

Output file format. Async export is NDJSON-only.

Available options:

ndjson

Example:

"ndjson"

string

Free-text search filter.

type

enum<string>

Filter by product type (e.g. physical, digital, giftCard, donation).

Available options:

physical,

digital,

giftCard,

donation

Example:

"physical"

brandName

string

Filter by brand name.

brandId

string[]

Filter by one or more brand IDs.

tagId

string[]

Filter by one or more tag IDs.

price

object

Inclusive price range using flat price.gte / price.lte fields (not the nested filter[price][gte] / filter[price][lte] query-string form).

Show child attributes

productIds

string[]

Limit export to up to 100 specific product IDs.

Maximum array length: 100

locations

string[]

ISO 3166-1 alpha-2 country codes used for price localisation. Defaults to ["US"].

Pattern: ^[A-Z]{2}$

Example:

["US"]

include

enum<string>[]

Related entities to include.

Minimum array length: 1

Related entities to include.

Available options:

brand,

tags

Example:

["brand", "tags"]

fields

enum<string>[]

Computed or expanded product fields for list responses.

Minimum array length: 1

Computed or expanded fields for product list responses.

Available options:

priceRange,

variantsCount,

total

Example:

["priceRange", "variantsCount"]

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

Export API: Bulk Catalog Ingestion

Create collections export

Authentication

Marketplace

Gifting

Administration

Create products export

Required fields:

Optional filters:

Optional response shaping:

Optional headers:

Behavior notes:

Permissions

Authorizations

Company Level Authentication

Headers

Body

Response