Skip to content

Sitemap Detail

Returns a single sitemap with its full field set — the data behind the admin Marketing → Search & SEO → Sitemaps view screen.

TIP

New here? Read the Sitemaps overview for what a sitemap does and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/sitemaps/{id}GET

Details

  • Requires an admin Bearer token in the Authorization header.
  • Unlike list rows, the detail endpoint returns indexFile and generatedSitemaps — the actual XML files produced by the last generate run.
  • indexFile is null and generatedSitemaps is empty until the sitemap has been generated at least once.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
idintNumeric id
fileNamestringIndex file name (ends with .xml)
pathstringPath where the index file is written (starts and ends with /)
generatedAtstringTimestamp of the last generate run, or null
indexFilestringPath of the generated index file, or null before first generate
generatedSitemapsstring[]Paths of the per-batch product / category / page XML files
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.