Skip to content
storefronts / Page templates
GET/api/page-template-entries/{id}/preview

Preview Page Template Entry

Renders a draft preview of a page-template entry owned by the authenticated user.

GET

Authentication

Requirement
Required
Credential type
session
Scopes
Not specified

Permissions

  • Requires an authenticated storefront session.

Headers

Path Parameters

NameRequiredTypeDetails
idYesNot specified
Description: Identifier for the resource.

Query Parameters

Request Body

Response Body

Example 200 response

json
{
  "html": "string",
  "root": {},
  "route": "string",
  "slug": "example-slug",
  "meta_title": "string",
  "meta_description": "string",
  "schema_json": "string",
  "faq_config": {},
  "values": {}
}

Errors

404 page_template_entry_not_found500 page_template_preview_failed

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified