Skip to main content
GET
/
v3
/
products
/
{productId}
Get product (VariationGroup) by id
curl --request GET \
  --url https://api.snappy.com/v3/products/{productId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "a1b2c3d4e5",
  "title": "Iphone 17 Pro Max",
  "createdAt": "2026-01-15T10:30:00Z",
  "media": [
    {
      "type": "image",
      "src": "https://media.snappy.com/image/asset123?w=1000&h=1000&q=80&f=auto"
    }
  ],
  "category": {
    "fullName": "gifts / electronics / iphones"
  },
  "catalog": "marketplace",
  "types": [
    "physical"
  ],
  "variantsCount": 123,
  "brand": {
    "id": "621f9d4b1e675adcbc196159",
    "name": "Apple",
    "description": "Cute pet brand"
  },
  "tags": [
    {
      "id": "t1",
      "name": "Popular"
    }
  ],
  "priceRange": {
    "min": {
      "amount": 10,
      "currency": "usd"
    },
    "max": {
      "amount": 10,
      "currency": "usd"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.snappy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
header
required

Partner API key. Finalized per partner integration agreement.

Headers

Snappy-Account-Id
string

Optional account identifier for swag validation/filtering.

Path Parameters

productId
string
required

Stable VariationGroup identifier.

Query Parameters

filter[price][gte]
number

Minimum price filter. Inclusive.

filter[price][lte]
number

Maximum price filter. Inclusive.

location
string
default:US

ISO 3166-1 alpha-2 country code (default US).

Pattern: ^[A-Z]{2}$
include
enum<string>[]

Related entities to include (JSON:API include), comma-separated. Supported values: brand, tags. Returned as full objects.

Available options:
brand,
tags
fields
enum<string>[]

Comma-separated list of computed/expanded fields for GET /v3/products/{productId}.

Available options:
priceRange,
variantsCount,
full

Response

Product (VariationGroup).

Product (VariationGroup). Optional fields are returned only when requested via include (related entities) or fields (computed/ expanded fields). Field availability depends on the calling endpoint — see the include / fields parameter descriptions.

id
string
required

Stable VariationGroup identifier.

Example:

"a1b2c3d4e5"

title
string
required
Example:

"Iphone 17 Pro Max"

createdAt
string<date-time>
required
Example:

"2026-01-15T10:30:00Z"

media
object[]
required

Product media items. Array order defines display order.

category
object
required
catalog
enum<string>
required

Product catalog. As a query value, omit filter[catalog] to search both catalogs.

Available options:
marketplace,
swag
Example:

"marketplace"

types
enum<string>[]
required

Product type. Used both as values of Product.types[] and as filter values for filter[types].

Available options:
physical,
digital,
giftCards,
donations
variantsCount
integer

Returned only when fields includes variantsCount or full.

Required range: x >= 0
Example:

123

brand
object

Returned only when include=brand. Nullable when the product has no brand.

tags
object[]

Returned only when include=tags.

priceRange
object

Min/max pricing across the product's variants. Returned only when fields includes priceRange or full.

Last modified on May 15, 2026