Function usePage

  • Get a Page Designer page based on a single page ID.

    The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility. 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.

    Parameters

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

    Returns UseQueryResult<Page, unknown>

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