Get base products
Use this endpoint to retrieve a paginated list of swag base products. Returns base-product templates across the swag catalog.
Filtering options
filter[brandId]- comma-separated list of brand IDs (OR semantics)filter[brandName]- case-insensitive substring search on brand namefilter[tagId]- comma-separated list of tag UUIDs (OR semantics)filter[title]- case-insensitive substring search on titlefilter[id]- comma-separated list of base-product UUIDsfilter[color]- comma-separated color titlesfilter[size]- comma-separated size titlesfilter[printingTechnique]- comma-separated printing-technique display nameslocation- required ISO 3166-1 alpha-2 country codeSnappy-Account-Idheader - required account identifier
Optional parameters
include=brand,tags- return related entities in the responsefields=options,printingTechnique- return the aggregated variant options array and printing techniquepage[number]/page[size]- page-number pagination (1-indexed; max 300 per page, default 100)
Please note
- Variants are not returned on this endpoint. Use GET /v3/swag/base-products//variants to retrieve the variants list for a specific base product.
- Unknown filter keys return a 400 error.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
Headers
Required. Account identifier.
1"acc123456"
Query Parameters
Comma-separated list of brand ids (OR semantics).
1Case-insensitive substring search on brand name.
1"Cotopaxi"
Comma-separated list of tag UUIDs (OR semantics). Each value must be a valid UUID.
Case-insensitive substring search on title.
1"Classic Tee"
Comma-separated list of base-product UUIDs.
Comma-separated color titles.
1Comma-separated size titles.
1Comma-separated printing-technique display names.
Supported printing-technique display name.
Direct to film, Direct to garment, Embroidery, Sublimation, Digital inkjet, Laser printing, UV printing, Digital printing Comma-separated list of expanded base-product fields.
options- includes the aggregated variant options array.printingTechnique- includes the printing technique display name, ornullwhen 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.
options, printingTechnique 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.
brand, tags 1-indexed page number.
x >= 11
Number of base products per page (max 300, default 100).
1 <= x <= 300100
Required ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$"US"
Response
Paginated list of base products.
Paginated base product list response (page-number pagination).