The BigCommerce x ReSci integration includes native support for sending transactional messages out of Cortex, based on certain events that occur in BigCommerce.
This allows you to consolidate all of your email messaging in one platform, and provides the flexibility of building these emails in Cortex to trigger messages like order confirmation, shipping confirmation, welcome, return confirmation and many more.
- BigCommerce transactional stage
- Creating your first BigCommerce transactional email
- Supported message types
- How to dynamically display all order items
- Using "For Loops" to use order product merge tags
- Using the merge tags to represent each item in an order
- Using the HTML editor to display all order product names in an order
- Using the drag-and-drop editor to display all order product names in an order
- Available merge tags
Need to setup the BigCommerce Integration and Transactional Stage? See our Setup Guide.
BigCommerce transactional stage
When the BigCommerce plugin is installed successfully (see Requirements for Setup), this will install a new Cortex stage under the "Experiments" section called "BigCommerce Transactional".
This should appear next to the "Custom Transactional" stage as shown below:
This stage is where you will configure and build the transactional emails that will send based on BigCommerce events (using BigCommerce's supported webhooks).
 |
Important: When a template is created and configured based on the transactional message type you'd like to send, your transactional emails will begin sending as soon as the email is activated. Do NOT activate emails in the BigCommerce Transactional stage that you are not yet ready to begin having sent to your users. |
Creating your first BigCommerce transactional email
- Click on "Manage Emails" on the "BigCommerce Transactional" stage in Cortex. You will be taken to the page below.
- Click "New Email" in the top right and select the "Create New" option to start the email creation process.
- You will then see a pop-up form that you will use to select your "Transactional Message" Type (see Supported Message Types for more information) and enter your "Email Name". Click "Continue" when ready to move on.
Note: For this example, we'll select "Order Confirmation" and named our email "Order Confirmation Test 1".
- You're taken to the normal email builder as seen in other stages (see below):
Follow the builder guides and select the "email type" you'll be using to build the Transactional Message, then click "Continue to Editor".
- Based on your selection, you'll build your email as needed using either the html or drag-and-drop editor. From here, you can dynamically insert information using the pre-defined Merge Tags from BigCommerce as shown below:
- Drag-and-drop builder example:
- HTML builder example:
- When your email is ready to send, you'll make sure to save the email and when you click "Continue to Summary", clicking "Activate Now" will allow this message to begin sending to all of your eligible recipients of the message. Nothing else is needed here!
|
Important: If wanting to test multiple transactional message emails simultaneously, you can activate several emails for a single Transactional Message Type – these emails will be randomized for sends to test performance of each template. |
Please reach out to help@retentionscience.com if you have any other questions on the setup process here.
Supported message types
|
Transactional message type |
Trigger description for the message |
|
Account Updated |
Customer is updated. Does not currently track changes to the customer address. |
|
Order Awaiting Fulfillment |
Customer has completed the checkout process and payment has been confirmed. |
|
Order Awaiting Payment |
Customer has completed checkout process, but payment has yet to be confirmed. |
|
Order Awaiting Pickup |
Order has been pulled, and is awaiting customer pickup from a seller-specified location. |
|
Order Awaiting Shipment |
Order has been pulled and packaged, and is awaiting collection from a shipping provider. |
|
Order Cancellation |
Seller has cancelled an order, due to a stock inconsistency or other reasons. |
|
Order Confirmation |
Order has been created successfully using the control panel, an app or via the API. |
|
Order Completed |
Client has paid for their digital product and their file(s) are available for download. |
|
Order Declined |
Seller has marked the order as declined for lack of manual payment, or other reasons. |
|
Order Disputed |
Customer has initiated a dispute resolution process for the PayPal transaction that paid for the order. |
|
Order Manual Verification Required |
Order on hold while some aspect needs to be manually confirmed. |
|
Order Partially Refunded |
Seller has partially refunded the order. |
| Order Partially Shipped | Only some items in the order have been shipped, due to some products being pre-order only or other reasons. |
|
Order Pending |
Customer started the checkout process, but did not complete it. |
|
Return Confirmation |
Seller has used the Refund action. |
|
Shipping Confirmation |
Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items action. |
|
Welcome |
A customer or subscriber is created in BigCommerce. |
How to dynamically display all order items
Using "For Loops" to use order product merge tags
The BigCommerce Transactional Stage allows you to use merge tags to dynamically add certain data points for each item in a particular order. This is typically seen in transactional messages like Order Confirmation, Shipping Confirmation, etc.
Using the merge tags to represent each item in an order
In order to support this, you will need to accompany the appropriate merge tag with a Liquid "for loop" to iterate through and list these dynamic values for each item in the users order.
Using the HTML editor to display all order product names in an order
In the example below, we've highlighted how you would use these tags in the html editor to represent each order_product.name value for the multiple items in the order.
{% for order_product in order.products %}
{{ order_product.name }}
{% endfor %}
This essentially allows you to represent the name of each product in the order without having to repeat the merge tag for each item.
Using the drag-and-drop editor to display all order product names in an order
In the next example, you'll see we've used the "Display Condition" feature in the template builder to setup our conditional statement to display all your order product name values.
- To display all items in your order, select the row in the editor that you want to repeat.
- Once the row is selected, you should see the row properties options as shown below.
- Click on the "Add condition" button under "Display condition" (this will repeat the row for each product in your order to show all order products).
- The "Add a new display condition" form should open and you will need to fill out the "Name", "Description", "Before", and "After" fields (all fields are required to save the display condition).
The "Before" value should be the opening Liquid "for loop" statement (in this example, we are using {% for order_product in order.products %).
This will iterate through each product in the order and display the contents of each row (if an order contains multiple items, multiple rows will be displayed).
The "After" value should close the Liquid "for loop" statement.
Available merge tags
Merge tags relevant to order transactional message types
|
Merge Tag Name |
Data Type |
Description |
Applicable Message Types |
Example Value
|
|
{{order.id}} |
integer |
The ID of the order (Order number). |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
118
|
| {{order.customer_id}} | integer | The ID of the customer placing the order; or 0 if it was a guest order. | All Messages | 6 |
| {{order.date_created}} | string | The date this order was created (Order date). | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Mon, 23 Apr 2018 18:04:48 +0000 |
| {{order.date_modified}} | string | The date the order was last modified. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Mon, 23 Apr 2018 18:04:49 +0000 |
| {{order.date_shipped}} | string | The date the order as shipped. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Wed, 14 Nov 2012 19:26:23 +0000 |
| {{order.status_id}} | integer | The status ID of the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 11 |
| {{order.cart_id}} | string | The cart ID from which this order originated, if applicable. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | a8458391-ef68-4fe5-9ec1-442e6a767364 |
| {{order.status}} | string | The status of your order in BigCommerce (ex: Awaiting Fulfillment, Pending, Shipped). | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Awaiting Fulfillment |
| {{order.custom_status}} | string | Displays the custom order status if applicable. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Awaiting Fulfillment |
| {{order.subtotal_ex_tax}} | string | The order subtotal excluding tax. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 225.0000 |
| {{order.subtotal_inc_tax}} | string | The order subtotal including tax. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 225.0000 |
| {{order.subtotal_tax}} | string | The total tax on the order subtotal. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.base_shipping_cost}} | string |
The value of the base shipping cost. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.shipping_cost_ex_tax}} | string |
The value of shipping cost, excluding tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.shipping_cost_inc_tax}} | string |
The value of shipping cost, including tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.shipping_cost_tax}} | string | The total order shipping cost tax. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.shipping_cost_tax_class_id}} | integer | Shipping-cost tax class. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 2 |
| {{order.base_handling_cost}} | string |
The value of the base handling cost. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.handling_cost_ex_tax}} | string |
The value of the handling cost, excluding tax.
|
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.handling_cost_inc_tax}} | number |
The value of the handling cost, including tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0 |
|
{{order.handling_cost_tax}}
|
string |
The total handling tax on the order. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
|
{{order.handling_cost_tax_class_id}}
|
integer | Handling cost tax class id value. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 2 |
|
{{order.base_wrapping_cost}}
|
integer |
The value of the base wrapping cost. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0 |
|
{{order.wrapping_cost_ex_tax}}
|
string |
The value of the wrapping cost, excluding tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
|
{{order.wrapping_cost_inc_tax}}
|
string |
The value of the wrapping cost, including tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.wrapping_cost_tax}} | string | The total wrapping cost tax on the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.wrapping_cost_tax_class_id}} | integer | Wrapping cost tax class id value. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 3 |
| {{order.total_ex_tax}} | string | Order total excluding tax. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 225.0000 |
| {{order.total_inc_tax}} | string | Order total including tax. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 225.0000 |
| {{order.total_tax}} | string |
Order total tax amount. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 225.0000 |
| {{order.items_total}} | number | The total number of items in the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 1 |
| {{order.items_shipped}} | number | The number of items that have been shipped. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0 |
|
{{order.payment_method}}
|
string | The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Cash on Delivery |
| {{order.payment_provider_id}} | string | The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used). | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | null |
| {{order.payment_status}} | string | The payment status of the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order.refunded_amount}} | string | The amount refunded from this transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.store_credit_amount}} | string | Represents the store credit that the shopper has redeemed on this individual order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.gift_certificate_amount}} | string | The order gift certificate amount used. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.ip_address}} | string |
IP Address of the customer, if known. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 12.345.678.910 |
| {{order.geoip_country}} | string | The full name of the country where the customer made the purchase, based on the IP. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | United States |
| {{order.geoip_country_iso2}} | string | The country where the customer made the purchase, in ISO2 format, based on the IP. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | US |
| {{order.currency_id}} | integer | The ID of the currency being used in this transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 1 |
| {{order.currency_code}} | string | The currency code of the currency being used in this transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | USD |
| {{order.currency_exchange_rate}} | string | The currency exchange rate. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 1.0000000000 |
| {{order.default_currency_id}} | integer | The default currency id. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 1 |
| {{order.default_currency_code}} | string | The currency code of the default currency for this type of transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | USD |
|
{{order.staff_notes}}
|
string | Any additional notes for staff. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Send Saturday |
| {{order.customer_message}} | string | Message that the customer entered in the Order Comments box during checkout. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Thank you |
| {{order.discount_amount}} | string | Amount of discount for this transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0.0000 |
| {{order.coupon_discount}} | string | Coupon discount amount. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 5.0000 |
| {{order.shipping_address_count}} | number | The number of shipping addresses associated with this transaction. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order.ebay_order_id}} | string | If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0 |
| {{order.billing_address.first_name}} | string | First name of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Jane |
| {{order.billing_address.last_name}} | string | Last name of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Doe |
| {{order.billing_address.company}} | string | Company name of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order.billing_address.street_1}} | string | Street information of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 123 Main Street |
| {{order.billing_address.street_2}} | string | Additional street information of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order.billing_address.city}} | string | City of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Austin |
| {{order.billing_address.state}} | string | State of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | TX |
| {{order.billing_address.zip}} | string | Zip code of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 12345 |
| {{order.billing_address.country}} | string | Country of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | United States |
| {{order.billing_address.country_iso2}} | string | Country code of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | US |
| {{order.billing_address.phone}} | string | Phone number of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order.billing_address.email}} | string | Email of the customer who placed the order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | janedoe@email.com |
| {{order.order_source}} | string | Orders submitted via the store’s website will include a www value. Orders submitted via the API will be set to external. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | www |
| {{order.external_source}} | string | For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass in a value identifying the system used to generate the order. For example: POS. Otherwise, the value will be null. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | null |
| {{order.external_id}} | string | ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | null |
|
{{order.external_merchant_id}}
|
string | Id of the external merchant. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | null |
| {{order.channel_id}} | number | Shows where the order originated. The channel_id will default to 1. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 1 |
| {{order.tax_provider_id}} | string |
BasicTaxProvider - Tax is set to manual. AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | BasicTaxProvider, AvaTaxProvider, |
|
{{order.tracking_number}}
|
string | Tracking number of the shipment. | Shipping Confirmation, Order Partially Shipped, Order Awaiting Shipment | w4se4b6ASFEW4T |
| {{order.shipping_method}} | string | Extra detail to describe the shipment, with values like: Standard, My Custom Shipping Method Name, etc. | Shipping Confirmation, Order Partially Shipped, Order Awaiting Shipment | Ship by Weight |
| {{order.shipping_provider}} | string | Enum of the BigCommerce shipping-carrier integration/module. | Shipping Confirmation, Order Partially Shipped, Order Awaiting Shipment | auspost, canadapost, endicia, usps, fedex, royalmail, ups, upsready, upsonline, shipperhq, |
| {{order.tracking_carrier}} | string | The carrier who will be tracking the shipment of the order. | Shipping Confirmation, Order Partially Shipped, Order Awaiting Shipment | auspost, canadapost, endicia, usps, fedex, royalmail, ups, upsready, shipperhq example: auspost |
| {{order.comments}} | string | Comments the shipper wishes to add. | Shipping Confirmation, Order Partially Shipped, Order Awaiting Shipment | Leave by mailbox |
| {{order_shipping_address.street_1}} | string | Street address (first line). | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
123 MainStreet |
| {{order_shipping_address.street_2}} | string | Street address (second line). | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | |
| {{order_shipping_address.city}} | string | Addressee city. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
Austin |
| {{order_shipping_address.zip}} | string | ZIP or postal code, as a string. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
12345 |
| {{order_shipping_address.country}} | string | Addressee’s country. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
United States
|
| {{order_shipping_address.country_iso2}} | string | 2-letter ISO Alpha-2 code for the country. (Looking Up Country Codes) | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | US |
| {{order_shipping_address.state}} | string | The name of the state or province. Should be spelled out in full, e.g.: California. | Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | Texas |
Merge tags relevant to inserting order products information
|
Field Name |
Data Type |
Description |
Applicable Message Types |
Example Value |
|---|---|---|---|---|
|
{{order_product.image_url}} |
string |
Image url of the product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
https://example.jpg |
|
{{order_product.product_id}} |
integer |
Numeric ID of the product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
20 |
|
{{order_product.name}} |
string |
The product name. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
Fog Linen Chambray Towel - Beige Stripe |
|
{{order_product.sku}} |
string |
User-defined product code/stock keeping unit (SKU). |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
S-GREE |
|
{{order_product.base_price}} |
string |
The product's base price. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
54.0000 |
|
{{order_product.price_ex_tax}} |
string |
The product’s price excluding tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
54.0000 |
|
{{order_product.base_total}} |
string |
Total base price. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
54.0000 |
|
{{order_product.total_ex_tax}} |
string |
Total base price excluding tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
54.0000 |
|
{{order_product.quantity}} |
number |
Quantity of the product ordered. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
1 |
|
{{order_product.weight}} |
string |
Weight of the product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
1 |
|
{{order_product.is_refunded}} |
boolean |
Whether the product has been refunded. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
false |
|
{{order_product.refunded_amount}} |
string |
The amount refunded from this transaction. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0.0000 |
|
{{order_product.return_id}} |
integer |
Numeric ID for the refund. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0 |
|
{{order_product.wrapping_name}} |
string |
Name of gift-wrapping option |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
null |
|
{{order_product.base_wrapping_cost}} |
string |
The value of the base wrapping cost. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0.0000 |
|
{{order_product.wrapping_cost_ex_tax}} |
string |
The value of the wrapping cost, excluding tax. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0.0000 |
|
{{order_product.wrapping_message}} |
string |
Message to accompany gift-wrapping option. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.quantity_shipped}} |
number |
Quantity of this item shipped. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0 |
|
{{order_product.event_name}} |
string |
Name of promotional event/delivery date. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
null |
|
{{order_product.event_date}} |
string |
Date of the promotional event/scheduled delivery. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.fixed_shipping_cost}} |
string |
Fixed shipping cost for this product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
0.0000 |
|
{{order_product.ebay_item_id}} |
string |
Item ID for this product on eBay. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.ebay_transaction_id}} |
string |
Transaction ID for this product on eBay. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.option_set_id}} |
integer |
Numeric ID of the option set applied to the product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
5 |
|
{{order_product.parent_order_product_id}} |
integer |
ID of a parent product. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.applied_discount.id}} |
string |
Name of the coupon applied to order |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
total-coupon |
|
{{order_product.applied_discount.amount}} |
string |
Amount of the discount. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
1.2100 |
|
{{order_product.applied_discount.name}} |
string |
Name of the coupon. `Manual Discount` when creating a manual discount. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
$5 off |
|
{{order_product.applied_discount.code}} |
string |
Coupon Code. There is no code when creating a manual discount. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
S2549JM0Y |
|
{{order_product.product_option.order_product_id}} |
integer |
53 |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.product_option.display_name}} |
string |
The name of the option, as shown on the storefront. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
Size |
|
{{order_product.product_option.display_value}} |
string |
The name of the value, as shown on the storefront. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
S |
|
{{order_product.product_option.value}} |
string |
|
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
70 |
|
{{order_product.external_id}} |
integer |
ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
|
{{order_product.upc}} |
string |
Universal Product Code. |
Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded |
|
Merge tags relevant to customer transactional message types
| Merge Tag Name | Data Type | Description | Applicable Message Types | Example Value |
| {{customer.id}} | integer | Unique numeric ID of this customer. | All Messages | 1 |
| {{customer.company}} | string | The name of the company for which the customer works. | Welcome, Account Updated | BigCommerce |
| {{customer.first_name}} | string | First name of the customer. | All Messages | Jane |
| {{customer.last_name}} | string | Last name of the customer. | All Messages | Doe |
| {{customer.email}} | string | Email address of the customer. | All Messages | janedoe@email.com |
| {{customer.phone}} | string | Phone number of the customer. | All Messages | 1234567890 |
|
{{customer.date_created}} |
string | Date on which the customer registered from the storefront or was created in the control panel. | Welcome, Account Updated | Thu, 11 Jan 2018 20:57:52 +0000 |
| {{customer.date_modified}} | string | Date on which the customer updated their details in the storefront or was updated in the control panel. | Welcome, Account Updated | Tue, 10 Apr 2018 18:59:05 +0000 |
| {{customer.store_credit}} | string |
The amount of credit the customer has. |
Welcome, Account Updated, Order Confirmation, Shipping Confirmation, Order Cancellation, Return Confirmation, Order Pending, Order Partially Shipped, Order Declined, Order Awaiting Payment, Order Awaiting Pickup, Order Awaiting Shipment, Order Completed, Order Awaiting Fulfillment, Order Manual Verification Required, Order Disputed, Order Partially Refunded | 0 |
| {{customer.registration_ip_address}} | string | The customer’s IP address when they signed up. | Welcome, Account Updated | 12.345.678.910 |
| {{customer.customer_group_id}} | integer | The group to which the customer belongs. | Welcome, Account Updated | 2 |
| {{customer.notes}} | string | Store-owner notes on the customer. | Welcome, Account Updated | |
| {{customer.tax_exempt_category}} | string | Used to identify customers who fall into special sales-tax categories – in particular, those who are fully or partially exempt from paying sales tax. Can be blank, or can contain a single AvaTax code. (The codes are case-sensitive.) Stores that subscribe to BigCommerce’s Avalara Premium integration will use this code to determine how/whether to apply sales tax. Does not affect sales-tax calculations for stores that do not subscribe to Avalara Premium. | Welcome, Account Updated |
Comments
0 comments
Please sign in to leave a comment.