Walking the Catalog

The hierarchy, the visibility rule, and what a widely shared product means for your data model.

The catalog is a hierarchy: brand, then collection, then product, then SKU. You walk it in that order.

GET /v4/connections
  -> brand_id
     GET /v4/retailers/brands/{brand_id}/collections
       -> collection_id
          GET /v4/retailers/collections/{collection_id}/products
            -> product_id
               GET /v4/retailers/products/{product_id}?collection_id={collection_id}

Everything you see is filtered to what the brand has actually shared with you. Visibility means two things at once: the product is in a collection shared with your account, and it is priced in a price type attached to your account. A product that fails either test does not appear anywhere in this API.

One product can sit in several collections. The collection_membership webhook section carries collections[] for exactly that reason. Two consequences for a mirror:

  • A walk of every collection will hand you the same product more than once. Deduplicate on product.id.
  • Full detail is collection scoped, because a brand can exclude specific colors from a specific collection and set per collection delivery windows. The same product read through two collections can therefore differ, and both answers are correct. Decide how your PIM models that before you seed, rather than after.

Each resource below has its own page with full request and response detail: Connections & Collections, Products & Prices, and Bulk Export (Seeding).