Skip to main content
GET
Get base product by ID

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

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

Headers

snappy-account-id
string
required

Required. Account identifier.

Minimum string length: 1
Example:

"acc123456"

Path Parameters

baseProductId
string<uuid>
required

Base-product UUID.

Example:

"048392af-5f4c-4ddc-b0e2-7a0edf152268"

Query Parameters

fields
enum<string>[]

Comma-separated list of expanded base-product fields.

  • options - includes the aggregated variant options array.
  • printingTechnique - includes the printing technique display name, or null when none applies.

When omitted, expanded fields are not returned.

Expanded fields for a swag base product. options returns the aggregated variant options array, and printingTechnique returns the printing technique display name or null.

Available options:
options,
printingTechnique
Example:
include
enum<string>[]

Related entities to include. brand and tags are returned only when requested.

Related entities to include with a swag base product. brand and tags are returned only when requested.

Available options:
brand,
tags
Example:
location
string
required

Required ISO 3166-1 alpha-2 country code.

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

"US"

Response

Base product.

Single base product.

data
object
required

Base product.

Last modified on September 23, 2026