Skip to main content

Config

Get meta tags​

POST /access/api/v1/config

Returns SEO meta tags for a given URL. Use this to populate <title>, <meta name="description">, and Open Graph tags for dynamic pages (products, categories, blog posts).

Request body:

{
  "url": "/product/:id",
  "param": "running-shoes"
}

url is the route pattern. param is the dynamic segment value (slug or ID). See SEO and Meta Tags for the full list of supported patterns.

Get sitemap​

GET /access/api/v1/config/site-map

Returns a sitemap object with URLs for all public pages: products, categories, and static pages. Use this to generate your sitemap.xml. See SEO and Meta Tags for the full response shape and Next.js example.

Possible errors: HOSTNAME_NOT_DETERMINED, DOMAIN_NOT_IDENTIFIED, SHOP_ID_NOT_FOUND, SHOP_URL_INVALID