--- title: usePopularProducts description: The `usePopularProducts` hook fetches popular products from the catalog. api_name: shop-minis source_url: html: 'https://shopify.dev/docs/api/shop-minis/hooks/product/usepopularproducts' md: 'https://shopify.dev/docs/api/shop-minis/hooks/product/usepopularproducts.md' --- # use​Popular​Products The `usePopularProducts` hook fetches popular products from the catalog. ## use​Popular​Products([params](#-propertydetail-params)​) ### Parameters * params UsePopularProductsParams ### Returns * UsePopularProductsReturns ### UsePopularProductsReturns * error Error | null * fetchMore () => Promise\ * hasNextPage boolean * loading boolean * products Product\[] | null * refetch () => Promise\ ### UsePopularProductsParams * fetchPolicy ```ts DataHookFetchPolicy ``` * first ```ts number ``` * skip ```ts boolean ``` ```ts interface UsePopularProductsParams extends PaginatedDataHookOptionsBase {} ``` ### DataHookFetchPolicy ```ts 'cache-first' | 'network-only' ``` ### UsePopularProductsReturns * error ```ts Error | null ``` * fetchMore ```ts () => Promise ``` * hasNextPage ```ts boolean ``` * loading ```ts boolean ``` * products ```ts Product[] | null ``` * refetch ```ts () => Promise ``` ```ts interface UsePopularProductsReturns extends PaginatedDataHookReturnsBase { products: Product[] | null } ``` ### Product * compareAtPrice ```ts Money | null ``` * defaultVariantId ```ts string ``` * featuredImage ```ts ProductImage | null ``` * id ```ts string ``` * isFavorited ```ts boolean ``` * price ```ts Money ``` * referral ```ts boolean ``` * reviewAnalytics ```ts { averageRating?: number; reviewCount?: number; } ``` * selectedVariant ```ts ProductVariant ``` * shop ```ts ProductShop ``` * title ```ts string ``` * variants ```ts ProductVariant[] ``` ```ts export interface Product { id: string title: string reviewAnalytics: { averageRating?: number | null reviewCount?: number | null } shop: ProductShop selectedVariant?: ProductVariant defaultVariantId: string isFavorited: boolean variants?: ProductVariant[] featuredImage?: ProductImage | null price: Money compareAtPrice?: Money | null referral?: boolean } ``` ### Money * amount ```ts Decimal ``` * currencyCode ```ts CurrencyCode ``` ```ts export interface Money { amount: Decimal currencyCode: CurrencyCode } ``` ### Decimal ```ts string ``` ### CurrencyCode ```ts 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KID' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' ``` ### ProductImage * altText ```ts string | null ``` * height ```ts number | null ``` * id ```ts string | null ``` * sensitive ```ts boolean | null ``` * thumbhash ```ts string | null ``` * url ```ts string ``` * width ```ts number | null ``` ```ts export interface ProductImage { id?: string | null altText?: string | null url: string width?: number | null height?: number | null /** * @deprecated This property will be removed in a future version */ sensitive?: boolean | null thumbhash?: string | null } ``` ### ProductVariant * compareAtPrice ```ts Money | null ``` * id ```ts string ``` * image ```ts ProductImage | null ``` * isFavorited ```ts boolean ``` * price ```ts Money ``` * title ```ts string ``` ```ts export interface ProductVariant { id: string title: string isFavorited: boolean image?: ProductImage | null price: Money compareAtPrice?: Money | null } ``` ### ProductShop * id ```ts string ``` * name ```ts string ``` ```ts export interface ProductShop { id: string name: string } ``` ### Examples * #### Example code ##### Default ```tsx import {usePopularProducts, Button} from '@shopify/shop-minis-react' export default function MyComponent() { const {products, loading, error, hasNextPage, loadMore} = usePopularProducts({ first: 10, }) console.log({products, loading, error}) return ( <> {/* Render products here */} {hasNextPage && ( )} ) } ```