Return Status Change Email Template | BigCommerce Developer Center

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

Object properties

Property	Type	Description
`return`	object
`return.id`	integer
`return.reason`	string
`return.action`	string
`return.comments`	string
`return.product`	object
`return.product.name`	string
`return.product.quantity`	integer
`return.product.price`	string
`return.product.sku`	string
`return.product.thumbnail`	string
`return.status`	object
`return.status.value`	integer
`return.status.formatted`	string
`return.store_credit`	object
`return.store_credit.value`	float
`return.store_credit.formatted`	string
`return.link`	string
`return.instructions`	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.title`	string
`translations.en.hello`	string
`translations.en.message`	string
`translations.en.received_credit`	string
`translations.en.details_title`	string
`translations.en.return_reason`	string
`translations.en.return_action`	string
`translations.en.return_comments`	string
`translations.en.check_status`	string
`translations.en.products_title`	string
`translations.en.quantity`	string
`translations.en.instructions_title`	string
`translations.en.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"
    }
  }
}