Get collection products
Use this endpoint to retrieve a paginated list of products within a specific collection. Designed for marketplace and browse experiences where you need a lightweight product list.
Filtering options
- Catalog (
marketplaceorswag; required, defaults tomarketplace) - Product types
Please note
Variants are not returned on this endpoint. Use GET /v3/products/{productId}/variants to retrieve the variants list for a specific product.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_API_KEYHeaders
Optional account identifier for swag validation/filtering.
"acc123456"
Optional company identifier for swag validation/filtering.
"cmp123456"
Path Parameters
Collection identifier.
^[A-Za-z0-9]{8,}$"abcdef12"
Query Parameters
Which product catalog to search. Required on product list/search endpoints. Defaults to marketplace.
marketplace, swag "marketplace"
Exact-match product type filter. Omit to include all types.
physical, digital, giftCard, donation "physical"
Free-text search across product title, category, and brand.
"tumbler"
Inclusive minimum price filter.
x >= 010
Inclusive maximum price filter.
x >= 0200
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$"US"
Related entities to include.
Related entities to include.
brand, tags ["brand", "tags"]Computed or expanded product fields for list responses.
Computed or expanded fields for product list responses.
priceRange, variantsCount, total ["priceRange", "variantsCount"]Opaque continuation token from the previous response links.next.
"opaqueCursorToken"
Number of products per page (max 300, default 100).
1 <= x <= 300100
JSON:API sort parameter. Single field; prefix with - for descending.
^-?(minPrice|createdAt)$"-minPrice"
Response
Paginated list of products.
Paginated product list response (cursor pagination). total is present only when requested via fields=total.
Products for the requested page.
Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).
Root-level total of products matching the request filters (ignores pagination). Returned only when fields=total.
x >= 0716