Shopify

List Shopify store sitemap

Get a Shopify store's sitemap index or one typed child sitemap, with last-modified dates and image metadata.

GET/v1/shopify/store/sitemap
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
6
storestringrequiredquery

The store's domain, for example `allbirds.com`, `www.allbirds.com` or `weareallbirds.myshopify.com`. A full URL is accepted and reduced to its host. Only public storefront hosts are accepted.

typestringoptionalquery

The child sitemap to return: `product`, `collection`, `page`, `blog`, `article`, `metaobject_page` or `agentic_discovery`. Omit for the sitemap index.

one of: product, collection, page, blog, article, metaobject_page, agentic_discovery

pageintegeroptionalquery

Child sitemap page, 1 to 10,000. Default: 1.

≥ 1 · ≤ 10000

localestringoptionalquery

The locale path prefix, e.g. `de-ch`. Omit for the root locale.

max 64 chars · pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

limitintegeroptionalquery

Entries per page, 1 to 250. Default: 250.

≥ 1 · ≤ 250

cursorstringoptionalquery

Cursor from `page.nextCursor` of the previous response. It only works with the same filters.

min 1 chars · max 4096 chars

Response fields
28

Endpoint-specific response payload.

datalookupStatus
string

`found` on success; `not_found` when it does not exist or is not a Shopify store; `private` when the storefront is password-protected; `restricted` when the store is paused or frozen.

one of: found, not_found, private, restricted

datastore
string

The store host that was requested.

datatype
stringnullable

The child sitemap type; null for the index.

Child sitemaps when the result is the sitemap index; empty otherwise.

datasitemaps[]url
string

The child sitemap URL.

datasitemaps[]type
string

Which kind of child it is.

datasitemaps[]page
integer

Its page number.

datasitemaps[]locale
string

Path prefix before the sitemap file; empty at the root locale.

datasitemaps[]from
stringnullable

`from` query value.

datasitemaps[]to
stringnullable

`to` query value.

Entries of a child sitemap; empty for the index.

dataentries[]url
string

The published URL.

dataentries[]handle
stringnullable

The last path segment (the resource handle).

dataentries[]type
string

Which sitemap it came from.

dataentries[]lastModified
stringnullable

`lastmod`, ISO 8601 UTC.

The entry's image metadata where the sitemap gives it.

dataentries[]imageurl
string

Image URL.

dataentries[]imagetitle
stringnullable

Image title.

dataentries[]imagecaption
stringnullable

Image caption.

datatruncated
boolean

True when the page stopped at the response bound.

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor for the next page; null on the last page.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/shopify/store/sitemap?store=www.allbirds.com" \
  -H "x-api-key: YOUR_API_KEY"

Responses

A Shopify sitemap index or one typed child sitemap.