Skip to main content
GET
/
v3
/
variants
/
{variantId}
Get single variant
curl --request GET \
  --url https://api.snappy.com/v3/variants/{variantId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "f6g7h8i9j0",
  "title": "$10 Gift Card",
  "selectedOptions": {
    "denomination": "$10"
  },
  "taxable": true,
  "media": [
    {
      "type": "image",
      "src": "https://media.snappy.com/image/asset123?w=1000&h=1000&q=80&f=auto"
    }
  ],
  "productId": "a1b2c3d4e5",
  "price": {
    "amount": 10,
    "currency": "usd"
  },
  "priceBreakdown": {
    "ddp": 0,
    "shippingFee": 2.5,
    "itemPrice": 43.2
  },
  "details": {
    "descriptionHtml": "<p>Digital gift card redeemable online.</p>",
    "includes": "<p>Charger, cable, earphones</p>",
    "features": "<string>",
    "specifications": {
      "material": "cotton",
      "dimensions": "10x20"
    },
    "notices": {
      "prop65Warning": "This product contains chemicals known to the State of California to cause cancer."
    }
  },
  "brand": {
    "id": "621f9d4b1e675adcbc196159",
    "name": "Apple",
    "description": "Cute pet brand"
  },
  "personalization": {
    "isPersonalized": true,
    "personalizationTemplateFields": [
      "firstName",
      "lastName",
      "department"
    ]
  }
}

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

variantId
string
required

Variant identifier (SnappyProduct._id).

Query Parameters

location
string
default:US

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

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

Comma-separated list of variant-level field expansions.

  • pricing — includes price and priceBreakdown.
  • details — includes the variant details wrapper.
  • brand — includes the variant's brand object.
  • full — every field above.

When omitted, price, priceBreakdown, and details are not returned.

Available options:
pricing,
details,
brand,
full

Response

Single variant.

A single variant. price, priceBreakdown, details, and brand are returned only when requested via fields on variant endpoints.

id
string
required
Example:

"f6g7h8i9j0"

title
string
required
Example:

"$10 Gift Card"

selectedOptions
object
required

This variant's selected option values (e.g. { "color": "Black", "size": "S" }).

Example:
{ "denomination": "$10" }
taxable
boolean
required
Example:

true

media
object[]
required

Variant media items. Array order defines display order.

productId
string

Parent product (VariationGroup) identifier.

Example:

"a1b2c3d4e5"

price
object

Variant price in a given currency.

priceBreakdown
object

Detailed breakdown of the variant price.

details
object

Variant-level descriptive content (details wrapper). Returned only when requested via fields=details on variant endpoints. Not returned on list / export endpoints.

brand
object

Returned when fields includes brand on variant endpoints.

personalization
object

null when the variant is not personalizable.

Last modified on May 15, 2026