Catalog GraphQL

Served by CatalogModule on commercetools, CatalogModule on medusa and CatalogModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the catalog types page.

Operations

Operation	Description	Served by
`categories`Query	Get a paginated list of product categories with optional search and sorting	commercetoolsmedusasfcc
`product`Query	Get a single product by its slug	commercetoolsmedusasfcc
`productCategoryPageByPath`Query	Get category page data with associated products and CMS content by path	commercetoolsmedusasfcc
`products`Query	Get a paginated list of all products without search or filtering	commercetoolsmedusasfcc
`productsBySku`Query	Retrieve specific products by their SKU values	commercetoolsmedusasfcc
`productSearch`Query	Search for products with advanced filtering, sorting, and pagination capabilities	commercetoolsmedusasfcc
`productSearchMaxResults`Query	The most products productSearch can reach by paging in this deployment, so a storefront stops offering pages past it; a page beyond it fails or comes back empty.	commercetoolsmedusasfcc
`productSearchSuggestions`Query	Suggestions for a partly typed search term, for the panel under a search field: completions of the term, the categories holding the most matching products, and the best matching products.	commercetoolsmedusasfcc
`productSortOrders`Query	The sort orders productSearch applies in this deployment, so a storefront offers only those.	commercetoolsmedusasfcc

Types

Type	Description
`AbstractProductSpecificationAttribute`Interface
`Brand`Object	A brand, as content refers to it by key.
`CatalogPage`Object
`CategoryFacet`Object	Category-based facet for hierarchical filtering (e.g., categories, collections)
`CategorySortOrderType`Enum	Available sorting options for category listings
`Dimension`Object	Dimension option specific for this variant (see ProductVariantDimension for available options)
`Facet`Union	Union of different facet types for product filtering
`FacetFilterInput`Input object
`FacetValue`Object	Individual value option within a facet with count information
`FilterCondition`Object	A condition a listing applies before the shopper's facet selections, which cannot widen it.
`FilterConditionInput`Input object	A condition a listing applies before the shopper's facet selections, which cannot widen it.
`LocalizedSlug`Object	Localized URL slug for different language versions
`Media`Union	Union of different media types available for products
`OptionsFacet`Object	Multi-option facet for categorical filtering (e.g., color, brand)
`Product`Object	Product entity containing all product information, variants, and metadata.
`ProductAccessory`Object	A variant sold for use with another one.
`ProductAccessoryKindType`Enum	How an accessory relates to the variant it is listed for.
`ProductAvailabilityType`Enum	Product availability status indicating stock levels and purchase options
`ProductBundle`Object	Products sold together with a main product, at the bundle's discount.
`ProductBundleItem`Object	A product offered as an extra in a bundle.
`ProductCategoriesResult`Object	Paginated result containing product category pages
`ProductCategory`Object
`ProductCategoryPage`Object	Product category page containing products and metadata
`ProductCategorySuggestion`Object	A category suggested for a search term, with how much of the result it holds.
`ProductDocument`Object	A file that belongs to a product variant, such as its datasheet.
`ProductDocumentKindType`Enum	What a product document is, so a page can group and label it.
`ProductEntityReference`Object	Reference to a product entity with basic information
`ProductImage360`Object	360-degree product image set for interactive viewing
`ProductKindType`Enum	How a product reaches the buyer.
`ProductList`Object
`ProductListingConfig`Object
`ProductPriceTier`Object	The unit price from an order quantity on.
`ProductRibbon`Object
`ProductSearchSuggestions`Object	What a search field suggests for a partly typed term.
`ProductSpecificationAttribute`Union
`ProductSpecificationBooleanAttribute`Object
`ProductSpecificationDateTimeAttribute`Object
`ProductSpecificationEnumAttribute`Object
`ProductSpecificationEnumListAttribute`Object
`ProductSpecificationEnumValue`Object
`ProductSpecificationGroup`Object
`ProductSpecificationNumberAttribute`Object
`ProductSpecificationStringAttribute`Object
`ProductsResult`Object	Paginated result containing products and available facets for filtering
`ProductVariant`Object	Specific variant of a product with unique SKU, pricing, and attributes
`ProductVariantDimension`Object	Product variant dimension containing selectable options (e.g., size, color)
`ProductVariantDimensionColorOption`Object	Color-based product variant dimension option with hex color value
`ProductVariantDimensionImageOption`Object	Image-based product variant dimension option (e.g., pattern, style)
`ProductVariantDimensionOption`Interface	Interface for product variant dimension options with common properties
`ProductVariantDimensionTextOption`Object	Text-based product variant dimension option (e.g., size, material)
`ProductVariantQuantityRule`Object	How many of a variant can be ordered on one line.
`ProductVariantStock`Object	A variant's stock, as a buyer is told it.
`ProductYouTubeVideo`Object	YouTube video embedded as product media
`RangeFacet`Object	Range-based facet for numeric filtering (e.g., price, rating)
`Reviews`Object
`StockLevelType`Enum	How a variant's stock reads to a buyer.
`ToggleFacet`Object	Boolean toggle facet for binary filtering (e.g., in stock, on sale)
`Warehouse`Object	A place stock is kept and shipped from.
`WarehouseStock`Object	How much of a variant one warehouse holds.