Return Requested Email Template | BigCommerce Developer Center

Return requested email triggers after a customer’s return is approved.

Object properties

Property	Type	Description
`return`	object
`return.return_id`	string
`return.reason`	string
`return.action`	string
`return.comments`	string
`return.products`	array
`return.products[].name`	string
`return.products[].quantity`	integer
`return.products[].price`	string
`return.products[].sku`	string
`return.products[].thumbnail`	string
`order`	object
`order.id`	integer
`store`	object
`store.name`	string
`store.domain_name`	string
`store.logo`	object
`store.logo.title`	string
`store.logo.name`	string
`store.logo.url`	string
`store.ssl_path`	string
`store.cdn_path`	string
`store.image_directory`	string
`store.img_path`	string
`store.path_normal`	string	Path to the store (i.e., domain + protocol)
`store.path`	string
`store.address`	string
`store.language`	object
`store.language.code`	string
`store.language.direction`	string	Left to right or right to left, depending on the language
`customer`	object
`customer.first_name`	string
`customer.full_name`	string
`customer.email`	string
`customer.group`	array
`customer.group[].name`	string
`misc`	object
`misc.year`	integer
`translations`	object
`translations.en`	object
`translations.en.confirmation`	string
`translations.en.summary`	string
`translations.en.clickHere`	string
`translations.en.reason`	string
`translations.en.action`	string
`translations.en.comments`	string
`translations.en.contains`	string
`translations.en.items`	string
`translations.en.quantity`	string

Example

{
  "return": {
    "return_id": 123,
    "reason": "reason of return",
    "action": "action",
    "comments": "sample comment",
    "order_id": 321,
    "products": [
      {
        "name": "Shower Gel",
        "quantity": 3
      }
    ],
    "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": null,
    "year": 2021,
    "translations": {
      "en": {
        "confirmation": "Confirmation for Return Request for Order ID",
        "summary": "A summary of your return is shown below. To view the status of this return",
        "clickHere": "click here",
        "reason": "Return Reason",
        "action": "Return Action",
        "comments": "Your Comments",
        "contains": "Your Return Request Contains the Following Items...",
        "items": "Return Items",
        "quantity": "Qty"
      }
    }
  }
}