marketing_templates_read
Arguments
required
Template trigger to list variables for. UNKNOWN is not a picker and returns empty lists.
Returns
required
Static trigger grammar for email templates: template variable names, Url keys, context objects, and table collection paths. Same for every store. Does not list discounts, saved sections, or product filters.
Show fields
Show fields
required
Structured objects blocks bind (
cartContext, reviewRequest, tracker, orderSummary).Show fields
Show fields
[String!]!
required
Typed or upcoming block payload keys that bind this object (
trackableSummary, products, qrCode, …).String!
required
Schema data type, e.g.
Trackable Summary or Cart Context.String!
required
What the object holds.
String!
required
CamelCase key to store on the block’s
schemaFieldName, e.g. orderSummary.Paths a DYNAMIC table may use as
rowCollection. Cell bindings stay empty until nested item schemas exist.Show fields
Show fields
String!
required
What the collection holds.
String!
required
Row alias each row is bound as. Always
item; cells must use {{ item.… }}.String!
required
Element type, e.g.
Line Item, Trackable Line Item, or Object.Boolean!
required
True when nested array paths under this object are merchant-defined (custom-event
properties). Append the array key to path.String!
required
Value for
rowCollection, e.g. relevantLineItems or properties.order_products.required
The trigger this catalog was built for.
required
required
Names for
{{ }} in subject, preview text, text blocks, and other authored strings.Show fields
Show fields
String!
required
Schema data type, including Maybe/Multiple prefixes, e.g.
Maybe Text.String!
required
What the value holds at send time.
String!
required
Merchant-facing label.
Boolean!
required
True when the email/SMS insert-variable picker would show this name. Hidden and structured fields still resolve if authored.
Boolean!
required
True when send-time resolution depends on a connected integration. The name is still listed; a missing integration yields an empty value.
String!
required
CamelCase schema key this name came from, e.g.
customerFirstName.String!
required
Snake_case identifier, e.g.
customer_first_name. Write {{ name }}.required
Whether this name comes from the trigger, renderer, or store.
Example
query {
emailTemplateVariableCatalog(trigger: ADDRESS_VERIFICATION_FAILED) {
trigger
}
}