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

Product Review Email Template

Was this page helpful?
Previous

Sign in Link Request Email Template

Next

Return Requested Email Template

Built with

Product review request email triggers after a customer purchases a product.

Object properties

review
object
review properties
products
array[object]
products items
name
string
sku
string
link
string
price
string
thumbnail
string
unsubscribe_link
string
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
instruction
string
review_text
string
thanks
string
go_shopping
string

Example

{
  "review": {
    "products": [
      {
        "name": "Name of Product",
        "sku": "FA44",
        "link": "#review-link"
      }
    ],
    "unsubscribe_link": "#unsubscribe-link"
  },
  "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",
    "language": {
      "code": "en",
      "direction": "ltr"
    }
  },
  "customer": {
    "first_name": "John",
    "full_name": "John Jr",
    "email": "john.f@example.com"
  },
  "misc": {
    "year": 2021
  },
  "translations": {
    "en": {
      "title": "Review products you've recently purchased",
      "hello": "Hello {{name}},",
      "message": "Thanks for your recent order with us!,",
      "instruction": "If you have a few minutes, we'd like to invite you to review the products you ordered. Just click on the link below to write a review and share your opinion with other shoppers.",
      "review_text": "Review product",
      "thanks": "Thanks in advance for taking the time to review the products you purchased!",
      "go_shopping": "Go shopping"
    }
  }
}