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
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
          • Overview
            • Global Email Object
            • Abandoned Cart
            • Abandoned Cart (Deprecated)
            • Account Details Changed
            • Account Reset Password
            • Combined Order Status
            • Create Account
            • Create Guest Account
            • Gift Certificate
            • Invoice
            • Order Message Notification
            • Order Ready for Pickup
            • Passwordless Login
            • Product Review
            • Return Confirmation
            • Return Status Change
          • Examples
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Object properties
  • Example
DocsAdminStore ConfigurationEmailsEmail object reference

Global Email Template Object

Was this page helpful?
Previous

Overview

Next

Abandoned Cart Email Template

Built with

Data objects across all email templates.

Object properties

store
object
store properties
name
string
domain_name
string
logo
object
logo properties
title
string
name
string
url
string
ssl_path
string
cdn_path
string
image_directory
string
img_path
string
path_normal
string
Path to the store (i.e., domain + protocol)
path
string
address
string
language
object
language properties
code
string
direction
string
Left to right or right to left, depending on the language
customer
object
customer properties
first_name
string
full_name
string
email
string
group
array[object]
group items
name
string
misc
object
misc properties
year
integer

Example

{
"store": {
"name": "string,",
"domain_name": "string",
"logo": {
"title": "string",
"name": "string",
"url": "string"
},
"ssl_path": "string",
"cdn_path": "string",
"image_directory": "string",
"img_path": "string",
"path_normal": "string",
"path": "string",
"address": "string",
"language": {
"code": "string",
"direction": "string"
}
},
"customer": {
"first_name": "string",
"full_name": "string",
"email": "string"
},
"misc": {
"year": "int"
}
}