Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.sitemap.show();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->sitemap->show();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.sitemap.show()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/sitemap \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/sitemap"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoply.gg/v1/stores/{storeId}/sitemap")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/sitemap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"url": "https://northwind.myshoply.gg/sitemap.xml",
"served": true,
"total": 9,
"listed": 9,
"priorities": [
"1.0",
"0.9"
],
"frequencies": [
"always",
"hourly"
],
"kinds": [
{
"id": "pages",
"listed": true,
"priority": "0.6",
"changefreq": "weekly",
"entries": [
{
"ref": "home",
"name": "Home",
"path": "/",
"changed": "2026-10-22",
"on": true,
"priority": "1.0",
"changefreq": "daily"
},
{
"ref": "products",
"name": "Products",
"path": "/products/",
"changed": "2026-10-22",
"on": true,
"priority": "0.6",
"changefreq": "weekly"
}
]
},
{
"id": "categories",
"listed": true,
"priority": "0.8",
"changefreq": "weekly",
"entries": [
{
"ref": "e31dbb6f-c007-4e28-b0f8-49c4b432cfec",
"name": "Software",
"path": "/products/?category=software",
"changed": "2026-10-22",
"on": true,
"priority": "0.8",
"changefreq": "weekly"
}
]
}
]
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Sitemap
Get the sitemap
Every address the store has, a kind at a time (pages, categories, products, blog), each with whether the sitemap lists it, its priority and how often it is said to change. This is the file the store serves at /sitemap.xml.
Needs the seo.read permission (Read Search Settings).
GET
/
stores
/
{storeId}
/
sitemap
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.sitemap.show();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->sitemap->show();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.sitemap.show()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/sitemap \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/sitemap"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoply.gg/v1/stores/{storeId}/sitemap")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/sitemap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"url": "https://northwind.myshoply.gg/sitemap.xml",
"served": true,
"total": 9,
"listed": 9,
"priorities": [
"1.0",
"0.9"
],
"frequencies": [
"always",
"hourly"
],
"kinds": [
{
"id": "pages",
"listed": true,
"priority": "0.6",
"changefreq": "weekly",
"entries": [
{
"ref": "home",
"name": "Home",
"path": "/",
"changed": "2026-10-22",
"on": true,
"priority": "1.0",
"changefreq": "daily"
},
{
"ref": "products",
"name": "Products",
"path": "/products/",
"changed": "2026-10-22",
"on": true,
"priority": "0.6",
"changefreq": "weekly"
}
]
},
{
"id": "categories",
"listed": true,
"priority": "0.8",
"changefreq": "weekly",
"entries": [
{
"ref": "e31dbb6f-c007-4e28-b0f8-49c4b432cfec",
"name": "Software",
"path": "/products/?category=software",
"changed": "2026-10-22",
"on": true,
"priority": "0.8",
"changefreq": "weekly"
}
]
}
]
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.

