Skip to main content

products

This query returns a collection of products that match the requested filters. Optional free-text search is compared against the product code or product name. Custom metadata is not included in search; use filters.metadata to filter by stored customerMetadata entries (same sanitisation rules as updateProductMetadata).

products(
  search: String
  pagination: Pagination
  options: QueryOptions
  filters: ProductsQueryFilters
): ProductData

Arguments​

products.search ● String scalar​

products.pagination ● Pagination input​

products.options ● QueryOptions input​

products.filters ● ProductsQueryFilters input​

Type​

ProductData object​

A collection of products and the relevant pagination information.