Function useProducts

  • Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              allImages?: boolean;
              currency?: string;
              expand?: GetProductsExpandEnum[];
              ids?: string[];
              inventoryIds?: string[];
              locale?: string;
              organizationId?: string;
              perPricebook?: boolean;
              select?: string;
              siteId?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<ProductResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : ProductResult>;
      }> = {}

    Returns UseQueryResult<ProductResult, unknown>

    A TanStack Query query hook with data from the Shopper Products getProducts endpoint.

    Parameter

    apiOptions - Options to pass through to commerce-sdk-isomorphic, with null accepted for unset API parameters.

    Parameter

    queryOptions - TanStack Query query options, with enabled by default set to check that all required API parameters have been set.

    See

Settings

Member Visibility

Theme