Function usePages

  • Get Page Designer pages.

    The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility. Either categoryId or productId must be given in addition to aspectTypeId. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most. Important: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.

    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

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters: { parameters?: string | undefined; categoryId?: string | undefined; productId?: string | undefined; aspectTypeId: string; aspectAttributes?: string | undefined; organizationId?: string | undefined; siteId?: string | undefined; locale?: string | undefined; };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<PageResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : PageResult>;
      }> = {}

    Returns UseQueryResult<PageResult, unknown>

    A TanStack Query query hook with data from the Shopper Experience getPages endpoint.

Settings

Member Visibility

Theme