Guides
Markdown
Retrieving Product Catalogs

The /products endpoint lets you dynamically fetch product data across players, teams, tags, and content types. It’s the foundation for powering storefronts, merch collections, and contextual product placementsβ€”like overlays during live video. You can retrieve products using:

  • GET β€” simple queries via URL parameters
  • POST β€” structured filters in a JSON request body for advanced use cases
πŸ“˜

All product objects include key details like name, price, tags, player/team associations and availability. See the API Reference for the full schema.


🎯 Vertical-Specific Parameters

Below are some examples, for the full list see the API Reference.

πŸ€ Sports Clients:

ParameterDescription
playerFilter by one or more player slugs
teamFilter by team slug
tagsCustom sports metadata (e.g. jersey_type:association)
products_perLimit results per player

πŸ₯» Fashion & Lifestyle Clients:

ParameterDescription
categorye.g. dresses, shoes, outerwear
tagsCustom fashion metadata (e.g. style:minimalist, y2k)
seasone.g. spring, fall
trendingBoolean flag for curated drops
πŸ’¬

Available filters depend on your vertical (e.g. Sports, Fashion, Creator). Some parameters may only be enabled for specific client types. Want to configure vertical-specific filters? Contact our team to tailor your catalog setup.


πŸš€ Endpoints

Fetch products via GET or POST across all catalog types.

  • GET /products – Lightweight filtering via query parameters
  • POST /products – Structured filter object with full flexibility

🧭 Common Query Examples (Sports Vertical)

These apply to sports + entertainment clients. Other verticals may vary.

1. Get Default Product List (e.g. Top Sellers)

shell

2. Filter by Team

shell

3. Starting Lineup (5 players, 3 products each)

shell

4. Filter by Tag (e.g. jersey type)

shell

πŸ” Using POST for Advanced Filters

Use the POST /products endpoint for complex filters, nested tags, or precise pagination:

shell

Request Example (Sports):

json

Request Example (Fashion):

json

πŸ“Ί

Looking to link products to video content? See Retrieving Products by Video


πŸ‘‰ Next: Working with Carts β†’