For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Cart Emails
        • Custom Template Associations
            • GETList Custom Template Associations
            • PUTUpsert Custom Template Associations
            • DELDelete Custom Template Associations
        • Email Templates
        • Pages
        • Marketing
        • Store Content
        • Themes
        • Widgets
        • Page Widgets
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
On this page
  • Creating template associations
  • Entity IDs
  • Getting available templates
  • Resources
RESTAdminContent

Custom Template Associations

Was this page helpful?
Previous

Update Email Template Settings

Next

List Custom Template Associations

Built with

Associate a Stencil themeʼs custom templates with products, categories, brands, and pages.

Creating template associations

To create a template association, use the Upsert custom template associations endpoint

Entity IDs

The value of the entity ID is the ID property for the given entity. For example, a category entity ID is the id property for the particular category object you want to act upon.

To get the entity IDs for categories, products, and brands, use the Get categories, Get products, and Get brands endpoints, respectively.

To get the entity ID for a page, use the Get pages endpoint.

Getting available templates

To get a list of available custom templates for each entity type, send a request to the Get all themes endpoint, then use the variation.uuid property as the path parameter in a request to the Get custom templates endpoint.

To get the version UUID for an active theme, use the Get a channel active theme endpoint.

Resources

  • Upsert custom template associations
  • Get categories
  • Get products
  • Get brands
  • Get pages
  • Get all themes
  • Get custom templates endpoint.
  • Get a channel active theme