Page templates
21 operations are available in this resource for the current release. Select an operation to view its request metadata and integration examples.
| Method | Operation | Description | Status |
|---|---|---|---|
GET | List Page Template Entries/api/page-template-entries | Lists the page-template entries of a project owned by the authenticated user. | Available |
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. | Available |
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. | Available |
GET | Get Page Template Entry/api/page-template-entries/{id} | Returns one page-template entry owned by the authenticated user. | Available |
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. | Available |
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. | Available |
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. | Available |
PUT | Update Page Template Variable/api/page-template-variables/{id} | Updates a page-template variable owned by the authenticated user. | Available |
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. | Available |
POST | Create Page Template/api/page-templates | Creates a page template in a project owned by the authenticated user and returns the created template. | Available |
DELETE | Delete Page Template/api/page-templates/{id} | Deletes a page template owned by the authenticated user along with its variables and entries. | Available |
GET | Get Page Template/api/page-templates/{id} | Returns one page template owned by the authenticated user. | Available |
PUT | Update Page Template/api/page-templates/{id} | Updates a page template owned by the authenticated user and returns the updated template. | Available |
POST | Create Archive/api/page-templates/{id}/archive | Archives a page template so it is no longer rendered on the storefront. | Available |
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. | Available |
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. | Available |
GET | List Thumbnail.webp/api/page-templates/{id}/thumbnail.webp | Returns the newest preview entry of a page template as a WebP thumbnail image. | Available |
GET | List Page Template Variables/api/page-templates/{id}/variables | Lists the variables configured on a page template owned by the authenticated user. | Available |
POST | Create Page Template Variable/api/page-templates/{id}/variables | Adds a variable to a page template owned by the authenticated user. | Available |
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. | Available |
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. | Available |