Skip to main content

storefrontCatalogRecords

Requires permission storefront:storefront:read.

Live categories, brands or products for storefront sections, one result per request and in request order. PICKED lists this organization's active records for the picked ids, in the order picked; ids with no active record (deleted, inactive or another organization's) are left out. AUTO lists the automatic category grid; NEWEST, IN_CATEGORY and IN_BRAND list the newest active products. A request for products also needs products:product:read. Ids, names and pictures only, never a price or a stock level. Writes nothing.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

query StorefrontCatalogRecords($input: StorefrontCatalogRecordsInput!) {
  storefrontCatalogRecords(input: $input) {
    records {
      id
      name
      imageUrl
      productCount
    }
  }
}

Variables:

{
  "input": {
    "requests": [
      {
        "source": "BRANDS"
      }
    ]
  }
}

Response:

{
  "data": {
    "storefrontCatalogRecords": [
      {
        "records": [
          {
            "id": "id",
            "name": "string",
            "imageUrl": "string",
            "productCount": 0
          }
        ]
      }
    ]
  }
}
storefrontCatalogRecords(
  input: StorefrontCatalogRecordsInput!
): [StorefrontCatalogResult!]!

Arguments​

storefrontCatalogRecords.input ● StorefrontCatalogRecordsInput! non-null input​

The details of the storefront catalog records request.

Type​

StorefrontCatalogResult object​

The records for one storefront section request.