InsightSocial API
Shopify

Shopify Store Sitemap API reference

Your first 10 calls are free, no card needed. Pricing and FAQ

Get a free API key
Example request
curl "https://api.insightsocial.app/v1/shopify/store/sitemap?store=<store>" \
  -H "x-api-key: $INSIGHTSOCIAL_API_KEY"
GET
/v1/shopify/store/sitemap

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

Beta. The source's own structure under our naming rules (snake_case keys, string ids, ISO times where the source gives a timestamp), not one of the schema-2 entities. Fields may change. See Beta endpoints.

20 credits per call.

Paginates by cursor: see Pagination.

x-api-key<token>

Your key from the dashboard. It starts with isk_.

In: header

Query Parameters

store*string

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.

type?string

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

Value in

  • "product"
  • "collection"
  • "page"
  • "blog"
  • "article"
  • "metaobject_page"
  • "agentic_discovery"
locale?string

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

limit?integer

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

Range1 <= value <= 250
cursor?string

Pass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.

dry_run?"1"

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.insightsocial.app/v1/shopify/store/sitemap?store=string"
{  "success": true,  "platform": "string",  "endpoint": "string",  "schema_version": "2",  "pagination": {    "next_cursor": "string",    "has_more": true,    "page_size": 0,    "stopped_at": "since"  },  "unavailable": [    "string"  ],  "credits_used": 0,  "credits_remaining": 0,  "request_id": "string",  "cached": true,  "idempotent_replay": true,  "charge_reason": "string",  "free_call": true,  "data": {    "property1": null,    "property2": null  }}