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

Return Status Change Email Template

Was this page helpful?
Previous

Return Requested Email Template

Next

Examples

Built with

Return status change email triggers after a customer return’s status has changed.

Object properties

return
object
return properties
id
integer
reason
string
action
string
comments
string
product
object
product properties
name
string
quantity
integer
price
string
sku
string
thumbnail
string
status
object
status properties
value
integer
formatted
string
store_credit
object
store_credit properties
value
float
formatted
string
link
string
instructions
string
order
object
order properties
id
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
received_credit
string
details_title
string
return_reason
string
return_action
string
return_comments
string
check_status
string
products_title
string
quantity
string
instructions_title
string
go_shopping
string

Example

{
  "return": {
    "id": 1,
    "reason": "reason of return",
    "action": "action",
    "comments": "sample comment",
    "product": {
      "name": "ProductName",
      "quantity": 2,
      "thumbnail_url": ""
    },
    "status": {
      "value": 1,
      "formatted": "Pending"
    },
    "store_credit": {
      "value": 10.1,
      "formatted": "$10.1 USD"
    },
    "link": "https://my-dev-store-97434969.store.bcdev/account.php?action=view_returns",
    "instructions": null
  },
  "order": {
    "id": 1
  },
  "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": "Return request status changed",
      "hello": "Hello {{name}}",
      "message": "The status of your return request for order #{{id}} has changed to <strong>{{status}}</strong>.",
      "received_credit": "You have received a store credit of {{credits}} To use it simply place your order and you will be able to choose store credit as the payment method when it comes time to pay for your order.",
      "details_title": "Return details",
      "return_reason": "Return reason:",
      "return_action": "Return action:",
      "return_comments": "Your comments:",
      "check_status": "Check return status",
      "products_title": "Return items",
      "quantity": "Qty:",
      "instructions_title": "Return Instructions:",
      "go_shopping": "Go shopping"
    }
  }
}