SEO
2 endpoints. Each needs an API key or OAuth token with the scope shown; the key already names its store, so paths start at /v1/store. Generated from the live contract; also in openapi.json.
Store-level search and social settings, plus sitemap and feed links
GET
/v1/store/seoOr name the store: GET /v1/stores/{storeId}/seo
Response SeoOverview
seoStoreSeorequiredoriginstringrequiredlinksobjectrequiredrobotsstringrequiredsitemapstringrequiredgoogleFeedstringrequiredmetaFeedstringrequired
fallbackobjectrequiredtitlestringrequireddescriptionstringrequired
updatedAtTimestamprequired
Example
curl "https://api.shopfa.st/v1/store/seo" \
-H "Authorization: Bearer $SHOPFAST_API_KEY"const res = await fetch('https://api.shopfa.st/v1/store/seo', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
},
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();import os, requests
res = requests.request(
"GET",
"https://api.shopfa.st/v1/store/seo",
headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()req, _ := http.NewRequest("GET", "https://api.shopfa.st/v1/store/seo", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)Try it with your key
Save store-level search and social settings
PUT
/v1/store/seoOr name the store: PUT /v1/stores/{storeId}/seo
Body
titlestring | nullrequireddescriptionstring | nullrequiredsocialImageUrlstring | nullrequiredallowIndexingbooleanrequiredblockAiCrawlersbooleanrequired
Response SeoOverview
seoStoreSeorequiredoriginstringrequiredlinksobjectrequiredrobotsstringrequiredsitemapstringrequiredgoogleFeedstringrequiredmetaFeedstringrequired
fallbackobjectrequiredtitlestringrequireddescriptionstringrequired
updatedAtTimestamprequired
Example
curl -X PUT "https://api.shopfa.st/v1/store/seo" \
-H "Authorization: Bearer $SHOPFAST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "string",
"description": "string",
"socialImageUrl": "https://example.com",
"allowIndexing": false,
"blockAiCrawlers": false
}'const res = await fetch('https://api.shopfa.st/v1/store/seo', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"title": "string",
"description": "string",
"socialImageUrl": "https://example.com",
"allowIndexing": false,
"blockAiCrawlers": false
}),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();import os, requests
res = requests.request(
"PUT",
"https://api.shopfa.st/v1/store/seo",
headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
json={
"title": "string",
"description": "string",
"socialImageUrl": "https://example.com",
"allowIndexing": False,
"blockAiCrawlers": False
},
)
res.raise_for_status()
data = res.json()req, _ := http.NewRequest("PUT", "https://api.shopfa.st/v1/store/seo", strings.NewReader(`{
"title": "string",
"description": "string",
"socialImageUrl": "https://example.com",
"allowIndexing": false,
"blockAiCrawlers": false
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)