Storefronts API

50 API operations were detected for the current release. Operations are grouped by the first stable resource in their path so related requests are easier to find.

How to Read This Reference

A value in braces, such as {project_id}, must be inserted into the endpoint path.
A field ending in ? is optional according to the detected request schema.
JSON body lists fields sent in the request body.
Query parameters lists values appended after ? in the URL.
When request details are not specified, the current release metadata does not provide enough information to publish them safely.

Resource Summary

Resource	Operations
Authentication	1
Custom ui	1
Downloads	3
Service status	1
On-site events	2
Customer account	2
Invitations	2
Current account	5
Page templates	21
Forms	8
Social authentication	3
Email verification	1

Authentication

Method	Operation	Description	Request information
`POST`	Resend verification code `/__runtime/auth/resend-verification-code`	Resends an email verification code for a pending storefront signup identified by cookie.	Request data read: headers, cookies

Custom ui

Method	Operation	Request information
`GET`	Get Custom Ui `/__runtime/custom-ui/{slug}`	Path parameters: `slug`

Downloads

Method	Operation	Description	Request information
`GET`	List File `/__runtime/downloads/file`	verifies a signed token, re-checks ownership when possible,	Query parameters: `DownloadFileQuery` (`token?`) Request data read: headers, host
`GET`	List Manifest `/__runtime/downloads/manifest`	resolves the product's download files and the caller's	Query parameters: `DownloadManifestQuery` (`product_id`, `variant_id?`, `order_token?`) Request data read: headers, host
`GET`	List Share `/__runtime/downloads/share`	consumes a revocable share token and streams/redirects the file.	Query parameters: `ShareQuery` (`token?`)

Service status

Method	Operation	Description	Request information
`GET`	List Heartbeat `/__runtime/heartbeat`	Returns a lightweight health-check response confirming the runtime service is reachable.	Request details are not specified in the current route metadata.

On-site events

Method	Operation	Description	Request information
`POST`	Create Onsite Event `/__runtime/onsite/events`	Records an on-site widget event for the storefront resolved from the request Host, deduplicating recent impressions.	JSON body: `RuntimeOnsiteEventPayload` (`widget_id`, `variant_id?`, `event_type`, `page_url?`, `referrer?`, `device_hash?`) Request data read: headers, host
`GET`	Get on-site snippet `/__runtime/onsite/snippet.js`	Returns the JavaScript snippet that renders a storefront's active on-site widgets.	Query parameters: key/value map Request data read: headers, host

Customer account

Method	Operation	Description	Request information
`GET`	List User Profile.json `/__runtime/user-profile.json`	Returns the signed-in storefront customer's profile, with logged_in set to false when no session is present.	Request data read: headers, host
`GET`	List Tab `/__runtime/user/tab`	Renders the storefront account tab page identified by the key query parameter, injecting account data such as orders, subscriptions, RMAs, and saved addresses.	Request data read: headers, host

Invitations

Method	Operation	Description	Request information
`POST`	Create Accept Invite `/accept-invite`	Accepts a storefront invitation, creates or activates the invited user account, and returns an auth token.	JSON body: key/value map Request data read: host
`GET`	Get Accept Invite `/accept-invite/{token}`	Renders the HTML invitation-acceptance form for a storefront invite token, or a terminal notice when the invite is already accepted or expired.	Path parameters: `token` Request data read: host

Current account

Method	Operation	Description	Request information
`GET`	List Me `/api/me`	Returns the signed-in account's identity, credit balance, template-management access, and permission scopes.	Authentication: session
`GET`	List Profile `/api/me/profile`	Returns the signed-in account identity, tenant identifier, application context, template-management access, and permission scopes.	Authentication: session
`GET`	List Me Transactions `/api/me/transactions`	Lists transactions owned by the signed-in account in reverse chronological order with pagination and optional test-mode inclusion.	Query parameters: `TransactionsQuery` (`limit?`, `offset?`, `include_test?`) Authentication: session
`GET`	List Transaction Events `/api/me/transactions/{id}/events`	Lists payment-provider events associated with a transaction owned by the signed-in account, ordered from oldest to newest.	Path parameters: `id` Authentication: session
`GET`	Get Me Transaction `/api/me/transactions/{id}/invoice`	Returns an HTML invoice for a transaction owned by the signed-in account, including its related payment-provider events.	Path parameters: `id` Authentication: session

Page templates

Method	Operation	Description	Request information
`GET`	List Page Template Entries `/api/page-template-entries`	Lists the page-template entries of a project owned by the authenticated user.	Query parameters: `ProjectScopedQuery` (`project_id?`) Authentication: session
`POST`	Create Page Template Entry `/api/page-template-entries`	Creates a page-template entry for a project owned by the authenticated user, resolving and storing its variable values.	JSON body: `CreateEntryBody` (`project_id?`, `template_id`, `title`, `slug?`, `route`, `status?`, `meta_title?`, `meta_description?`, `schema_json?`, `faq_config?`, `values?`) Authentication: session
`DELETE`	Delete Page Template Entry `/api/page-template-entries/{id}`	Deletes a page-template entry owned by the authenticated user along with its stored values.	Path parameters: `id` Authentication: session
`GET`	Get Page Template Entry `/api/page-template-entries/{id}`	Returns one page-template entry owned by the authenticated user.	Path parameters: `id` Authentication: session
`PUT`	Update Page Template Entry `/api/page-template-entries/{id}`	Updates a page-template entry owned by the authenticated user and returns the updated entry.	Path parameters: `id` JSON body: `UpdateEntryBody` (`template_id?`, `title?`, `slug?`, `route?`, `status?`, `meta_title?`, `meta_description?`, `schema_json?`, `faq_config?`, `values?`) Authentication: session
`GET`	Preview Page Template Entry `/api/page-template-entries/{id}/preview`	Renders a draft preview of a page-template entry owned by the authenticated user.	Path parameters: `id` Authentication: session
`DELETE`	Delete Page Template Variable `/api/page-template-variables/{id}`	Deletes a page-template variable owned by the authenticated user and its stored entry values.	Path parameters: `id` Authentication: session
`PUT`	Update Page Template Variable `/api/page-template-variables/{id}`	Updates a page-template variable owned by the authenticated user.	Path parameters: `id` JSON body: `UpdateVariableBody` (`key?`, `label?`, `type?`, `default_value?`, `options?`, `sort_order?`) Authentication: session
`GET`	List Page Templates `/api/page-templates`	Lists the page templates of a project owned by the authenticated user, including each template's variables and saved draft.	Query parameters: `ProjectScopedQuery` (`project_id?`) Authentication: session
`POST`	Create Page Template `/api/page-templates`	Creates a page template in a project owned by the authenticated user and returns the created template.	JSON body: `CreateTemplateBody` (`project_id?`, `name`, `slug?`, `description?`, `template_html?`, `template_json?`, `faq_section_template?`, `faq_item_template?`, `status?`) Authentication: session
`DELETE`	Delete Page Template `/api/page-templates/{id}`	Deletes a page template owned by the authenticated user along with its variables and entries.	Path parameters: `id` Authentication: session
`GET`	Get Page Template `/api/page-templates/{id}`	Returns one page template owned by the authenticated user.	Path parameters: `id` Authentication: session
`PUT`	Update Page Template `/api/page-templates/{id}`	Updates a page template owned by the authenticated user and returns the updated template.	Path parameters: `id` JSON body: `UpdateTemplateBody` (`name?`, `slug?`, `description?`, `template_html?`, `template_json?`, `faq_section_template?`, `faq_item_template?`, `status?`) Authentication: session
`POST`	Create Archive `/api/page-templates/{id}/archive`	Archives a page template so it is no longer rendered on the storefront.	Path parameters: `id` Authentication: session
`PUT`	Update Draft `/api/page-templates/{id}/draft`	Saves the supplied snapshot as the editable draft of a page template without changing the published version.	Path parameters: `id` JSON body: `DraftSnapshot` (`name`, `slug`, `description?`, `template_html?`, `template_json?`, `faq_section_template?`, `faq_item_template?`, `variables?`) Authentication: session
`POST`	Create Publish `/api/page-templates/{id}/publish`	Publishes the supplied snapshot as the live version of a page template, creating or updating its variables.	Path parameters: `id` JSON body: `DraftSnapshot` (`name`, `slug`, `description?`, `template_html?`, `template_json?`, `faq_section_template?`, `faq_item_template?`, `variables?`) Authentication: session
`GET`	List Thumbnail.webp `/api/page-templates/{id}/thumbnail.webp`	Returns the newest preview entry of a page template as a WebP thumbnail image.	Path parameters: `id` Authentication: session
`GET`	List Page Template Variables `/api/page-templates/{id}/variables`	Lists the variables configured on a page template owned by the authenticated user.	Path parameters: `id` Authentication: session
`POST`	Create Page Template Variable `/api/page-templates/{id}/variables`	Adds a variable to a page template owned by the authenticated user.	Path parameters: `id` JSON body: `CreateVariableBody` (`key`, `label`, `type?`, `default_value?`, `options?`, `sort_order?`) Authentication: session
`POST`	Preview Page Template `/api/page-templates/preview`	Renders the supplied page-template draft with resolved variable values and returns the preview HTML, root JSON, and rendered document.	JSON body: `PreviewDraft` (`snapshot`, `entry_id?`, `template_id?`, `blog_content_id?`, `blog_archive?`) Query parameters: `ProjectScopedQuery` Authentication: session
`POST`	Create Preview Css `/api/page-templates/preview-css`	Renders the supplied page-template draft through the preview service and returns the generated CSS stylesheet.	Query parameters: `ProjectScopedQuery` Authentication: session

Forms

Method	Operation	Description	Request information
`GET`	List Forms `/api/projects/{project_id}/forms`	Lists the forms defined for the target project.	Path parameters: `project_id`
`POST`	Create Form `/api/projects/{project_id}/forms`	Creates a form for the target project.	Path parameters: `project_id` JSON body: `CreateFormPayload` (`name`, `type`, `description?`, `fields?`, `layout?`, `settings?`, `formKey?`)
`DELETE`	Delete Form `/api/projects/{project_id}/forms/{form_id}`	Deletes a form from the target project.	Path parameters: `project_id`, `form_id`
`PUT`	Update Form `/api/projects/{project_id}/forms/{form_id}`	Updates a form for the target project.	Path parameters: `project_id`, `form_id` JSON body: `UpdateFormPayload` (`name`, `type`, `description?`, `fields?`, `layout?`, `settings?`, `formKey?`)
`GET`	List Form Submissions `/api/projects/{project_id}/forms/{form_id}/submissions`	Lists submissions for a form in the target project.	Path parameters: `project_id`, `form_id` Query parameters: `ListSubmissionsQuery` (`project_id`, `status?`, `limit?`, `offset?`)
`DELETE`	Delete Form Submission `/api/projects/{project_id}/forms/{form_id}/submissions/{submission_id}`	Deletes a form submission from the target project.	Path parameters: `project_id`, `form_id`, `submission_id`
`PUT`	Update Form Submission `/api/projects/{project_id}/forms/{form_id}/submissions/{submission_id}`	Updates the status of a form submission in the target project.	Path parameters: `project_id`, `form_id`, `submission_id` JSON body: `UpdateSubmissionPayload` (`status`)
`POST`	Submit Form `/api/public/forms/submit`	Submits a public form entry identified by projectId and formKey.	JSON body: `PublicSubmitPayload` (`projectId`, `formKey`, `data`)

Method	Operation	Description	Request information
`GET`	Get Auth `/auth/{provider}`	Redirects the browser to the configured social provider's authorization page to begin a storefront login or signup.	Path parameters: `provider` Query parameters: key/value map Request data read: host
`GET`	Handle Auth callback `/auth/{provider}/callback`	Handles the OAuth callback for a configured social login provider, exchanges the authorization code for a profile, creates or links the storefront user session, and redirects back to the storefront.	Path parameters: `provider` Query parameters: key/value map Request data read: headers, host
`GET`	Start social handoff `/auth/social/handoff`	Redeems a one-time social-login handoff token to set the storefront auth cookies and redirects to the original return path.	Query parameters: key/value map Request data read: host

Email verification

Method	Operation	Description	Request information
`GET`	List Verify Email `/verify-email`	Verifies a storefront user's email from the verification link and activates the account.	Query parameters: key/value map Request data read: headers, cookies

Reference Coverage

Request body, query, path, header, cookie, and session information is shown only when it can be detected from current route, spec, schema, or test metadata. Response fields, pagination behavior, sorting, filtering, and error mappings are omitted when that metadata is unavailable.