Get collection product

curl --request GET \
  --url https://api.snappy.com/public-api/v2/collections/{collectionId}/products/{productId} \
  --header 'X-Api-Key: <api-key>'

{
  "id": "string",
  "title": "string",
  "category": "string",
  "brand": {
    "id": "abCd57eFG0",
    "name": "Brand Name",
    "description": "Brand Description"
  },
  "coverImage": {
    "position": 1,
    "type": "image",
    "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
    "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
  },
  "options": {
    "takeYourPick": "Rainbow Bagel Making Kit",
    "color": "Black",
    "size": "S",
    "scent": "Lavender",
    "flavor": "Chocolate",
    "beverageType": "Coffee"
  },
  "tags": [
    {
      "id": "tag12345A",
      "name": "Tag Name",
      "color": "#000000",
      "position": 1
    }
  ],
  "variants": [
    {
      "id": "ab6789cd",
      "optionAttributes": {
        "takeYourPick": "Rainbow Bagel Making Kit",
        "color": "Black",
        "size": "S",
        "scent": "Lavender",
        "flavor": "Chocolate",
        "beverageType": "Coffee"
      },
      "brand": {
        "id": "abCd57eFG0",
        "name": "Brand Name",
        "description": "Brand Description"
      },
      "components": "string",
      "description": "Variant description",
      "features": "Variant features",
      "category": "Electronics / Audio / Headphones / Wireless Earbuds",
      "mediaItems": [
        {
          "position": 1,
          "type": "image",
          "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
          "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
        }
      ],
      "position": 0,
      "types": [
        "digital"
      ],
      "tags": [
        {
          "id": "tag12345A",
          "name": "Tag Name",
          "color": "#000000",
          "position": 1
        }
      ],
      "title": "Variant title",
      "information": {
        "including": "<ul><li>Cute puppy</li></ul>",
        "description": "<p>Cutest puppy in the world</p>",
        "features": "<ul><li>Floppy ears</li><li>Big eyes</li></ul>",
        "specifications": {
          "colorFamily": "Brown",
          "dimensions": "37in x17in 6in",
          "materials": "Cotton",
          "weight": "1.5 lbs"
        }
      },
      "notices": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "pricing": {
        "US": {
          "cost": 100,
          "ddp": 10,
          "shipping": 5,
          "totalFee": 2,
          "totalTax": 7,
          "totalFinalCost": 109
        }
      },
      "supportedCountries": [
        {
          "countryCode": "US"
        },
        {
          "countryCode": "CA"
        },
        {
          "countryCode": "GB"
        },
        {
          "countryCode": "DE"
        },
        {
          "countryCode": "FR"
        }
      ]
    }
  ],
  "types": [
    "digital"
  ],
  "mediaItems": [
    {
      "position": 1,
      "type": "image",
      "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
      "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
    }
  ],
  "notices": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Collections

Get collection product

Use this endpoint to retrieve a specific Product from a specific Collection.

Required fields:

collectionId - the Collection identifier, passed as a path parameter
productId - the Product identifier, passed as a path parameter

Optional parameters:

minBudget / maxBudget query parameters - optional inclusive budget range
companyId query parameter - Company ID (when not inferable from the calling key)
accountId query parameter - Account ID for Account-scoped Collections
country query parameter - ISO 3166-1 alpha-2 country code (default US)
fields query parameter - comma-separated field projection. Valid values: mediaItems, tags, brand, optionAttributes, notices, pricing, supportedCountries, full
throwIfNotFound query parameter - when true (default), returns 404 if the product isn’t in the Collection. When false, returns an empty response instead.
Request-Source header - source of the request

Please note:

Returns the full Product object including variants when fields=full is provided.
Returns 404 when the Product isn’t in the Collection and throwIfNotFound=true.

Permissions

Requires: products:read

GET

collections

{collectionId}

products

{productId}

Get collection product

curl --request GET \
  --url https://api.snappy.com/public-api/v2/collections/{collectionId}/products/{productId} \
  --header 'X-Api-Key: <api-key>'

{
  "id": "string",
  "title": "string",
  "category": "string",
  "brand": {
    "id": "abCd57eFG0",
    "name": "Brand Name",
    "description": "Brand Description"
  },
  "coverImage": {
    "position": 1,
    "type": "image",
    "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
    "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
  },
  "options": {
    "takeYourPick": "Rainbow Bagel Making Kit",
    "color": "Black",
    "size": "S",
    "scent": "Lavender",
    "flavor": "Chocolate",
    "beverageType": "Coffee"
  },
  "tags": [
    {
      "id": "tag12345A",
      "name": "Tag Name",
      "color": "#000000",
      "position": 1
    }
  ],
  "variants": [
    {
      "id": "ab6789cd",
      "optionAttributes": {
        "takeYourPick": "Rainbow Bagel Making Kit",
        "color": "Black",
        "size": "S",
        "scent": "Lavender",
        "flavor": "Chocolate",
        "beverageType": "Coffee"
      },
      "brand": {
        "id": "abCd57eFG0",
        "name": "Brand Name",
        "description": "Brand Description"
      },
      "components": "string",
      "description": "Variant description",
      "features": "Variant features",
      "category": "Electronics / Audio / Headphones / Wireless Earbuds",
      "mediaItems": [
        {
          "position": 1,
          "type": "image",
          "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
          "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
        }
      ],
      "position": 0,
      "types": [
        "digital"
      ],
      "tags": [
        {
          "id": "tag12345A",
          "name": "Tag Name",
          "color": "#000000",
          "position": 1
        }
      ],
      "title": "Variant title",
      "information": {
        "including": "<ul><li>Cute puppy</li></ul>",
        "description": "<p>Cutest puppy in the world</p>",
        "features": "<ul><li>Floppy ears</li><li>Big eyes</li></ul>",
        "specifications": {
          "colorFamily": "Brown",
          "dimensions": "37in x17in 6in",
          "materials": "Cotton",
          "weight": "1.5 lbs"
        }
      },
      "notices": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "pricing": {
        "US": {
          "cost": 100,
          "ddp": 10,
          "shipping": 5,
          "totalFee": 2,
          "totalTax": 7,
          "totalFinalCost": 109
        }
      },
      "supportedCountries": [
        {
          "countryCode": "US"
        },
        {
          "countryCode": "CA"
        },
        {
          "countryCode": "GB"
        },
        {
          "countryCode": "DE"
        },
        {
          "countryCode": "FR"
        }
      ]
    }
  ],
  "types": [
    "digital"
  ],
  "mediaItems": [
    {
      "position": 1,
      "type": "image",
      "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
      "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
    }
  ],
  "notices": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.

Getting Your API Key

Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
Optional mTLS: Enable mutual TLS for enhanced security
Name Your Key: Provide a descriptive name for easy identification

Using Your API Key

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

X-Api-Key: YOUR_24_CHARACTER_API_KEY

API Key Management

Maximum Keys: Up to 3 active API keys per company
Rotation: Delete old keys before creating new ones when at the limit
Security: Keys are hashed and cannot be retrieved after creation

Enhanced Security (mTLS)

For production environments, enable mutual TLS authentication:

Set enforceMtls: true when creating the API key
Contact support to obtain your client certificates
Use the mTLS endpoint: https://mtls-api.snappy.com/public-api

Headers

Request-Source

enum<string>

Source of the request

Available options:

api_native,

api_zapier,

api_salesforce,

api_ftp,

api_make

Example:

"api_native"

Path Parameters

collectionId

string

required

Collection ID.

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

Example:

"abcdef12"

productId

string

required

Product ID.

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

Example:

"ab1234cd"

Query Parameters

minBudget

number

Minimum budget

Required range: 1 <= x <= 20000

Example:

1

maxBudget

number

Maximum budget

Required range: 1 <= x <= 20000

Example:

10000

companyId

string

Company ID

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

Example:

"12345678"

country

string

default:US

accountId

string

Account ID

Example:

"a12bcd34"

fields

enum<string>[]

List of additional fields to include in response objects

Minimum array length: 1

The fields to return additionally in response. Valid values are: mediaItems, tags, brand, optionAttributes, notices, pricing, supportedCountries, full.

Available options:

mediaItems,

tags,

brand,

optionAttributes,

notices,

pricing,

supportedCountries,

full

Example:

["full"]

throwIfNotFound

boolean

default:true

Response

Successful response

Response containing product with variants.

string

Product ID

Example:

"abc12345"

title

string

Product title

Example:

"Product Title"