productCategoryPageByPath

Queryin Catalog

Get category page data with associated products and CMS content by path

Arguments

Argument	Type	Description
path	String!

Returns

ProductCategoryPage

Field	Type	Description
meta	PageMeta	Page metadata for SEO and other purposes
path	String!	The URL path of the category page
name	String	The name of the page.
indexable	Boolean	Indicates whether the page is indexable for search engines.
category	ProductCategory!	The product category associated with this page
productListingConfig	ProductListingConfig!	Configuration for the product listing on this page
breadcrumbs	[Breadcrumb!]!	The breadcrumbs representing the navigation path to the page.

Example

Query

query {
  productCategoryPageByPath(path: "/categories/electronics/laptops") {
    path
    name
    category {
      id
      name
      description
    }
    productListingConfig {
      categoryId
      defaultOrder
    }
    breadcrumbs {
      name
      path
    }
  }
}

Response

{
  "data": {
    "productCategoryPageByPath": {
      "path": "/example",
      "name": "Example",
      "category": {
        "id": "id-1",
        "name": "Example",
        "description": "Example"
      },
      "productListingConfig": {
        "categoryId": "Example",
        "defaultOrder": "RELEVANCE"
      },
      "breadcrumbs": [
        {
          "name": "Example",
          "path": "/example"
        }
      ]
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Resolved