Function useProduct

  • Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. Along with product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products will be included, as appropriate.

    Parameters

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

    Returns UseQueryResult<Product$0, unknown>

    A TanStack Query query hook with data from the Shopper Products getProduct 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