Choose a version:

sitemap

query

Returns sitemap data for a specific resource type, enabling headless storefronts to generate XML sitemaps for search engine optimization. The query provides a page count and paginated access to resources like Product, Collection, Page, and Blog objects.

When paginating through resources, the number of items per page varies from 0 to 250, and empty pages can occur without indicating the end of results. Always check hasNextPage to determine if more pages are available.

Anchor to Arguments

Arguments

Anchor to typetype

•SitemapType!

required

The type of the resource for the sitemap.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to SitemapSitemap

•Sitemap!

Contains all fields required to generate sitemaps.

Anchor to pagesCountpagesCount

•Count

The number of sitemap's pages for a given type.

Anchor to resourcesresources

•PaginatedSitemapResources

A list of sitemap's resources for a given type.

Important Notes:

The number of items per page varies from 0 to 250.
Empty pages (0 items) may occur and do not necessarily indicate the end of results.
Always check hasNextPage to determine if more pages are available.

Anchor to pagepage •Int! required: The page number to fetch.

Was this section helpful?