Docs
Dashboard
On this page

    Pages

    4 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.

    Custom pages and policies

    GET/v1/store/pages

    Or name the store: GET /v1/stores/{storeId}/pages

    storefront:readlistPages

    Response ListPagesResponse

    • pagesStorePage[]required

    Example

    curl "https://api.shopfa.st/v1/store/pages" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"
    const res = await fetch('https://api.shopfa.st/v1/store/pages', {
  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/pages",
    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/pages", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Create a page (body is sanitized)

    POST/v1/store/pages

    Or name the store: POST /v1/stores/{storeId}/pages

    storefront:writecreatePage

    Body

    • handlestringrequired
    • titlestringrequired
    • bodyHtmlstringrequired
    • seoTitlestring | nullrequired
    • seoDescriptionstring | nullrequired
    • templateSuffixstring | nullrequired
    • publishedbooleanrequired

    Response StorePage

    • idPageIdrequired
    • handlePageHandlerequired
    • titlestringrequired
    • bodyHtmlstringrequired
    • seoTitlestring | nullrequired
    • seoDescriptionstring | nullrequired
    • templateSuffixstring | nullrequired
    • publishedbooleanrequired
    • updatedAtTimestamprequired

    Example

    curl -X POST "https://api.shopfa.st/v1/store/pages" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "string",
  "title": "string",
  "bodyHtml": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "templateSuffix": "string",
  "published": false
}'
    const res = await fetch('https://api.shopfa.st/v1/store/pages', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "handle": "string",
    "title": "string",
    "bodyHtml": "string",
    "seoTitle": "string",
    "seoDescription": "string",
    "templateSuffix": "string",
    "published": false
  }),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();
    import os, requests

res = requests.request(
    "POST",
    "https://api.shopfa.st/v1/store/pages",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    json={
      "handle": "string",
      "title": "string",
      "bodyHtml": "string",
      "seoTitle": "string",
      "seoDescription": "string",
      "templateSuffix": "string",
      "published": False
    },
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("POST", "https://api.shopfa.st/v1/store/pages", strings.NewReader(`{
  "handle": "string",
  "title": "string",
  "bodyHtml": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "templateSuffix": "string",
  "published": false
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Update a page

    PUT/v1/store/pages/{pageId}

    Or name the store: PUT /v1/stores/{storeId}/pages/{pageId}

    storefront:writeupdatePage

    Parameters

    • pageIdpg_…pathrequired

    Body

    • handlestringrequired
    • titlestringrequired
    • bodyHtmlstringrequired
    • seoTitlestring | nullrequired
    • seoDescriptionstring | nullrequired
    • templateSuffixstring | nullrequired
    • publishedbooleanrequired

    Response StorePage

    • idPageIdrequired
    • handlePageHandlerequired
    • titlestringrequired
    • bodyHtmlstringrequired
    • seoTitlestring | nullrequired
    • seoDescriptionstring | nullrequired
    • templateSuffixstring | nullrequired
    • publishedbooleanrequired
    • updatedAtTimestamprequired

    Example

    curl -X PUT "https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "string",
  "title": "string",
  "bodyHtml": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "templateSuffix": "string",
  "published": false
}'
    const res = await fetch('https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "handle": "string",
    "title": "string",
    "bodyHtml": "string",
    "seoTitle": "string",
    "seoDescription": "string",
    "templateSuffix": "string",
    "published": 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/pages/pg_0123456789abcdefghjk",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    json={
      "handle": "string",
      "title": "string",
      "bodyHtml": "string",
      "seoTitle": "string",
      "seoDescription": "string",
      "templateSuffix": "string",
      "published": False
    },
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("PUT", "https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk", strings.NewReader(`{
  "handle": "string",
  "title": "string",
  "bodyHtml": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "templateSuffix": "string",
  "published": false
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Delete a page

    DELETE/v1/store/pages/{pageId}

    Or name the store: DELETE /v1/stores/{storeId}/pages/{pageId}

    storefront:writedeletePage

    Parameters

    • pageIdpg_…pathrequired

    Response Ok

    • okbooleanrequired

    Example

    curl -X DELETE "https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"
    const res = await fetch('https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk', {
  method: 'DELETE',
  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(
    "DELETE",
    "https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("DELETE", "https://api.shopfa.st/v1/store/pages/pg_0123456789abcdefghjk", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Was this page helpful?
    Report an issue