products

Queryin Catalog

Get a paginated list of all products without search or filtering

Arguments

Argument	Type	Description
page	Int!	Default 1
pageSize	Int!	Default 20

Returns

ProductsResult!

Field	Type	Description
items	[Product!]!	List of products in the result
pagination	Pagination!	Where this page sits within the full result set
facets	[Facet!]	Available facets for filtering
queryId	String	The search engine's id for this search, for click and conversion analytics that attribute an event to the search it came from. Null where the engine issues none, or analytics is not enabled for it.
correctedSearchTerm	String	The term the products were found for, where the term as typed found nothing and the engine's top suggestion did. Null when the term was searched as given, and always null with exactSearchTerm.
redirect	SearchRedirect	Where one of the engine's keyword rules sends this search term instead of to a result page. Null where the engine has no matching rule.

Example

Query

query {
  products(page: 1, pageSize: 50) {
    pagination {
      totalCount
      hasNextPage
    }
    items {
      id
      slug
      name
      variant {
        id
        sku
        price {
          gross {
            centAmount
            currency
          }
        }
      }
    }
  }
}

Response

{
  "data": {
    "products": {
      "pagination": {
        "totalCount": 1,
        "hasNextPage": true
      },
      "items": [
        {
          "id": "id-1",
          "slug": "/example",
          "name": "Example",
          "variant": {
            "id": "id-1",
            "sku": "SKU-1",
            "price": {
              "gross": {
                "centAmount": 1,
                "currency": "EUR"
              }
            }
          }
        }
      ]
    }
  }
}

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