Custom Notifications - Variables

ECSC.png

To allow merchants to edit the system default messages, SHOPLINE provides the "Custom Notification" feature which enables editors to add text, images, links to the notification emails and SMS to provide customers with more customized relevant information. This article will go over copying and adding variables to the custom notification templates.

*Note: Before you start editing, please confirm whether your plan can use the "Customize Notification" application. To enable the SMS feature, please contact Merchant Success Team.

For operation details and procedures, please refer to the two FAQ articles below:

 

1. List of Variables

The followings are the variables that can be used in each notification. Please use "Control + F" (Windows) or "Command + F" (iOS) to find the keyword more efficiently.

A. Variables for member notifications

Member Notifications

Variable

Description

Common variables for member notifications

{{shop.name}}

Your shop's name

{{customer.name}}

Customer's name

{{notification.url}}

Shop shorten URL

Member Account Setup/Import Notification

{{notification.url}}

Setup password URL

Membership Upgrade Notification

{{customer.tier.name}}

Customer's membership tier

{{customer.tier.member_discount}}

Customer's membership tier discount

Assign Store Credits Notification

{{store_credit.value}}

Assign store credit amount

{{store_credit.credit_balance}}

Customer's store credit balance

Store Credit Expired Notification

{{expiry_credit_amount}}

Stores credit amount to be expired

{{store_credit.end_at}}

Store credit expiration date

Welcome Credits Notification

{{store_credit.value}}

Welcome credit amount

{{store_credit.credit_balance}}

Customer credit balance

Birthday Credits Notification

{{store_credit.value}}

Birthday credit amount

{{store_credit.credit_balance}}

Customer credit balance

Order Reward Credits Notification

{{store_credit.value}}

Order reward credit amount

{{store_credit.credit_balance}}

Customer credit balance

Member Referral Notification

(to Referrer)

{{customer.name}}

Referrer's name

{{store_credit.value}}

Referrer reward credit to be assigned to referrer after new member placed an order

Member Referral Notification 

(to New member)

{{customer.name}}

New member's name

{{store_credit.value}}

Member referral credit amount

Referrer Reward Notification 

(to Referrer)

{{customer.name}}

Referrer's name

{{store_credit.value}}

Referrer reward credit

{{store_credit.credit_balance}}

Customer credit balance

Assign Member Points Notification

{{member_point.value}}

Assigned member point amount

{{member_point.point_balance}}

Customer member point balance

Earn Points Notification

{{member_point.value}}

Accumulated order reward points

{{member_point.point_balance}}

Customer point balance

 

Coupon Notification

 

{{promotion.title}} 

Promotion Name

{{promotion.start_at}}

Start date of promotion

{{promotion.end_at}}

End date of promotion

 

B. Variables for order notifications

Member Notifications

Variable

Description

Common variables for order notification

{{shop.name}}

Your shop's name

{{order.seller.email}}

Your shop's email

{{notification.url}}

Shop shorten URL

Customer related 

{{customer.name}}

Customer’s name

{{customer.email}}

Customer’s email

{{customer.phone | mask: phone}}

Customer’s phone number (3 middle digits masked)

{{customer.gender}}

Customer’s gender

{{customer.birthday | date: "%b %d, %Y"}}

Customer’s birthday

{{customer.attributes}}

{{attribute | first}}

{{attribute | last}}

Customer’s custom fields

Order related

{{order.customer_url}}

Order URL

{{order.status_label}}

Order status

{{order.remarks}}

Order remarks

{{customer.attributes}}

{{attribute | first}}

{{attribute | last}}

Order custom fields

{{order.payment_slip_url}}

Pay and upload payment slips

{{order.created_at | date: "%Y-%m-%d %H:%M%p"}}

Order date

{{order.order_number}}

Order number

Payment related

{{order.subtotal_price}}

Subtotal

{{order.discount_price}}

Discount

{{order.custom_discount_price}}

Custom discount total amount

{{order.applied_user_credit}}

Applied store credits

{{order.redeemed_points_to_cash}}

Member points redeemed for cash

{{order.redeemed_points_to_cash_amount}}

Applied point discount

{{order.delivery_fee}}

Delivery fee

{{order.exclusive_tax.fee}}

Tax fee

{{order.total_price}}

Total price

{{order.inclusive_tax}}

{{order.inclusive_tax.name}}

{{order.inclusive_tax.rate}}

{{order.inclusive_tax.fee}}

Tax included

{{order.earned_credit_value}}

Credits earned after paid

{{order.redeemed_points_to_gift}}

Points used to redeem gifts

{{order.earned_points_pending_days}}

{{order.earned_points}}

Point Assign Day

{{order.order_payment.status_label}}

Payment status

{{order.order_payment.name}}

Payment option

{{order.order_payment.instructions}}

Payment instructions

{{order.order_payment.instruction_image}}

{{order.order_payment.instruction_image.src | img_url: '750x'}}

{{order.order_payment.instruction_image | img_url: '750x'}}

Payment instruction image

{{order.order_payment.txn_id}}

PayPal transaction ID

{{order.order_payment.type}}

Payment type

{{order.order_payment.transaction_id}}

Transaction ID

{{order.order_payment.fee}}

Payment fee

{{order.subtotal_price}}

Subtotal

{{order.discount_price}}

Discount

Delivery related

{{order.order_delivery.status_label}}

Delivery status

{{order.order_delivery.name}}

Delivery option

{{order.delivery_date}}

{{order.delivery_time_slot}}

Delivery date

{{order.order_delivery.description}}

Delivery description

{{order.order_delivery.address.address.address1}}

Address

{{order.order_delivery.address.address.address2}}

{{order.order_delivery.address.address.city}}

{{order.order_delivery.address.address.state}}

{{order.order_delivery.address.address.country}}

{{ order.order_delivery.address.address.postcode }}

{{order.order_delivery.recipient_name}}

Recipient name

{{order.order_delivery.recipient_phone}}

Recipient phone number

{{order.order_delivery.location_code}}

Pick Up store code

{{order.order_delivery.location_name}}

Pick Up store name

{{order.order_delivery.delivery_name_title}}

Courier company name (as a title)

{{order.order_delivery.delivery_name}}

Courier company name/HOP! Address/ SF Express address

{{order.order_delivery.tracking_number}}

Tracking number

{{order.order_delivery.url}}

Delivery tracking URL

{{order.order_delivery.shipment_number}}

Shipment number

{{order.order_delivery.sn_id}}

Shop-to-Shop delivery ID

{{line_item.catcher_delivery_status}}

Delivery status from the manufacturer

Product related

{{order.line_items}}

Order items

{{line_item.image_url}}

Product image

{{line_item.title}}

Product name

{{line_item.type}}

Product type

{{line_item.variation_names}}

{{name}} for loop

Variation name

{{line_item.child_products}}

Bundled product

{{child_product.title}}

Bundled product name

{{child_product.variation_names}}

Bundled product variation name

{{line_item.quantity}}

Product quantity

{{line_item.item_points}}

Number of points redeemed for product

{{line_item.price}}

Product price

{{line_item.preorder_note}}

Preorder product notice

{{line_item.total_points}}

Total points

{{line_item.total_price}}

Total price

Subscription order related

 

{{product_subscription.next_billing_at}}

Next order creation time

{{subscription_product.title}}

Subscription product 

{{product_subscription.recurring_count}}

Subscription

{{product_subscription.next_recurring_count}}

Number of subscription 

{{product_subscription.duration}}

Subscription cycle

{{product_subscription.recurring_count_limit}} Subscription limit 

Split order related

{{order.parent_order_number}}

New Order (Split Order) number has been created 

 

2. Lists of variables for 11 custom notifications

  • Payment Slip Upload Notification, Order Message Notification, Email Verification Notification, Mobile Verification Notification, Shop Message Notification, Abandoned Cart Notification, and Back in Stock Notification - Click here
  • Variables for Order Canceled Notification, SHOPLINE Payments Refund Notification - Click here
  • Customer Return Order Request Notification, Returned Order Status Update Notification - Click here

 

3. Notes

  • If you have enabled the feature to send SMS, SHOPLINE will charge a monthly fee for the SMS service. 
  • The sample character count of the email subject and SMS message is only for reference and does not serve as the final number of characters. The number is subjected to the text converted from the variables, e.g. {{store_credit.credit_balance}}.  
  • The "Send Order Status Update SMS Notifications" toggle button has been removed from the Order Settings page. To enable or disable the SMS notification feature, go to the Custom Notification edit page.
    Screen_Shot_2021-11-03_at_4.20.28_PM.png
  • The variable and URL shown in the preview is a sample of how the variables will be converted. Please refer to the list of variables for editing the actual message content.
  • The system does not yet support multi-language translation. If you enter English content in the Traditional Chinese tab, the customer who has set to receive messages in Traditional Chinese will receive the text content in English. Please be sure to confirm the language tab when editing.
  • The system will determine the language of the notification received by the customer according to the customer's login status and whether the store language has been modified:
    • The customer has not logged in and has not switched the store language: Default Shop Language (based on customer's browser language or merchant's custom choice)
    • The customer has not logged in and has switched the store language: The store language most recently switched by the customer.
    • The customer has logged in and has not switched the store language: Customer's browser language
    • The customer has logged in and has switched the store language: The store language most recently switched by the customer.

 

Read more

 

 

 

 

 

Have more questions? Submit a request

Comments