A TanStack Query query hook with data from the Shopper Experience getPages
endpoint.
apiOptions - Options to pass through to commerce-sdk-isomorphic
, with null
accepted for unset API parameters.
queryOptions - TanStack Query query options, with enabled
by default set to check that all required API parameters have been set.
commerce-sdk-isomorphic
documentation for more information on the parameters and returned data type.useQuery
reference for more information about the return value.
Get Page Designer pages.
The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility. Either
categoryId
orproductId
must be given in addition toaspectTypeId
. 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.