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

Gift Certificate Email Template

Was this page helpful?
Previous

Create Guest Account Email Template

Next

Order Email Template

Built with

Gift certificate recipient email triggers when a customer purchases a gift certificate.

Object properties

certificate
object
certificate properties
code
string
to_name
string
to_email
string
from_name
string
from_email
string
amount
string
redeem_link
string
expiry_date
object
expiry_date properties
formatted
string
value
integer
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
translations
object
translations properties
en
object
en properties
title
string
hello
string
message
string
expiry_info
string
instruction
string
attached
string
warning
string
go_shopping
string

Example

{
"certificate": {
"code": "FA-21465",
"to_name": "John",
"to_email": "john.f@example.com",
"from_name": "John Wick",
"from_email": "johnwick@example.com",
"amount": "12.34",
"redeem_link": "#redeem-link",
"expiry_date": {
"formatted": "03/01/2121",
"value": 1614615821
}
},
"store": {
"name": "My Dev Store 97434969",
"domain_name": "my-dev-store-97434969.store.bcdev",
"logo": {
"title": [
"= My Dev Store 97434969 ="
],
"name": "avatar-2020_1612860757__16350.jpeg",
"url": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg"
},
"ssl_path": "https://my-dev-store-97434969.store.bcdev",
"cdn_path": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96",
"image_directory": "product_images",
"img_path": "https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images",
"path_normal": "https://my-dev-store-97434969.store.bcdev",
"path": "https://my-dev-store-97434969.store.bcdev",
"address": "123 Fake St, Dallas, TX 75225 USA",
"language": {
"code": "en",
"direction": "ltr"
}
},
"customer": {
"first_name": "John",
"full_name": "John Jr",
"email": "john.f@example.com"
},
"misc": {
"year": 2021
},
"translations": {
"en": {
"title": "You have received a Gift Certificate for {{name}}",
"hello": "Dear {{name}},",
"message": "{{from_name}} ({{from_email}}) has sent you a {{amount}} gift certificate for <a href=\\{{path}}\\>{{name]}</a>.",
"expiry_info": "You have until {{date}} to use this gift certificate before it expires.",
"instruction": "For instructions on how to redeem your gift certificate please <a href=\\{{link}}\\>click here</a>.",
"attached": "Your gift certificate is attached to this email.",
"warning": "Please download or print a copy of your gift certificate for safe keeping as gift certificates are non-transferable.",
"go_shopping": "Go shopping"
}
}
}