ShipRush

Template Editor

Note: The information in this topic provides auxiliary template information. The following topics provide step-by-step instructions for creating the respective template: Managing Email Notification Templates, Managing Packing List Templates and Images, and Managing Tracking Page Templates.

The Template Editor can be used to fully customize your Email Notifications and Packing Lists. Do the following:

  1. Display the Templates page (SETTINGS > ACCOUNT SETTINGS > Templates).

  2. Do one of the following to open the Template Editor:

    • In Email Templates, Packing List Templates, or Tracking Page Templates, click Add Template.

    • Select an existing template by clicking copy.

The Template Editor is displayed:

In the Template Editor, you can modify the:

  • Content, such as adding or removing text and fields, inserting your company's Terms & Conditions or Tracking Number, or removing existing merge codes

  • Layout of the template, such as adding or removing content blocks, moving fields and information, and adding tables

  • Formatting by adjusting the font type, font size, or indentation, or by creating numbered or bulleted lists, as well as other options

Most changes and additions can be made quickly and easily. Modifications that are more involved may require HTML knowledge and editing the template's HTML source code.


Merge Codes

Merge codes are special commands that begin with @. They allow the information in each Email Notification or Packing List to reflect the data from a specific Order. The common merge codes are listed at the right side of the Template Editor (see above graphic). To insert a merge code, simply click its name.

For example, if you enter @PostalCode, the Email Notification or Packing List shows the actual Postal Code from the Order (for example, 33709-1235). Additionally, you can enter a label, such as "Postal Code:", at left of @PostalCode. The Email Notification or Packing List shows: Postal Code: 33709-1235.

Each merge code is replaced with the corresponding information from the Order. They can include the Package Weight, Shipment Date, Tracking Number, Web Store Name, and many other types of information.


Modifying Template by Editing HTML

To edit the HTML code for the template or insert a customized HTML template, click Source in the Template Editor. This option can provide additional control over the formatting of the template. However, you can create professional templates without working in the HTML code.

Tip: When editing HTML, be sure to replace appropriate content with the corresponding merge codes.

Warning: Descartes ShipRush support is not able to assist with customizing templates at the HTML/source level.


Adding Custom Barcodes To Packing List Template

A special merge code is available to create a barcode in your Packing List template. These barcodes can scan for any type of information, but are limited to letters, numbers, and "-". Other special symbols do not work properly with barcodes.

The basic barcode merge code format is: @Model.Barcode("Barcode Type", Barcode Content).

The Barcode Content can be regular text (for example, your contact phone number), but more commonly it is used to fill-in another merge code (for example, the Order Number or Part number). Any merge code that works in a Packing List template can also work in a barcode.

Examples:

  • The barcode scans your Order Number: @Model.Barcode("Code93", Order.OrderNumber)

  • The barcode scans your item's SKU: @Model.Barcode("Code93", Item.ExternalID)

Tip: The @ symbol is not needed for merge codes inside the parenthesis. The @ located outside of the parenthesis (at far left) is needed.


Barcode Types

There are many different types of barcodes. "Code93" is a common barcode choice. The following types of barcodes are also available:

  • Code128

  • Code39

  • Postnet

  • UPCA

  • EAN8

  • ISBN

  • Codabar

  • I2of5

  • Code93

  • EAN13

  • JAN13

  • Bookland

  • UPCE

  • PDF417

  • PDF417Truncated

  • DataMatrix

  • QRCode

  • Aztec

  • Planet

  • EAN128

  • GS1_128

  • USPSSackLabel

  • USPSTrayLabel

  • DeutschePostIdentcode

  • DeutschePostLeitcode

  • Numly

  • PZN

  • OpticalProduct

  • SwissPostParcel

  • RoyalMail

  • DutchKix

  • SingaporePostalCode

  • EAN2

  • EAN5

  • EAN14

  • MacroPDF417

  • MicroPDF417

  • GS1_DataMatrix


Merge Code Elements

Shipment Merge Codes


Shipment.Carrier

Shipping Carrier

ServiceTypeAsString

Shipping Service

ShipDate

Embed this in a formatting function, like this:

@Convert.ToDateTime(Model.Shipment.ShipDate).ToString("d")

// 6/15/2008

@Convert.ToDateTime(Model.Shipment.ShipDate).ToString("D")

// Sunday, June 15, 2008

@Convert.ToDateTime(Model.Shipment.ShipDate).ToString("U")

// Monday, June 16, 2008 4:15:07 AM

ShipmentNumber

Tracking Number

WebstoreName

Webstore Name

WebStoreTypeProper

WebStoreType human readable, E.g. eBay

Shift4Shop, etc

WebstoreType

WebStore Type e.g. ebay, Shift4Shop, etc (always lower case)

Shipment.BOLNumber

LTL Related: Bill of Lading Number

Shipment.PRONumber

LTL Related: PRO Number, the tracking number for the shipment



Order Merge Codes


OrderDate

Embed in a formatting function, as above with ShipDate. E.g.

@Convert.ToDateTime(Order.OrderDate).ToString("d")

OrderNumber

Order number

AlternativeOrderNumber

Alt. Order number

OrderId

Internal Order ID (GUID of order within Descartes ShipRush)

ExternalTransactionId

ID of Transaction, order belongs to

ExternalID

External order ID

ShipMethod

Shipping method requested

IsShipped

True if order is shipped, False, if not

IsCancelled

True if order was cancelled, False, if not

PackageActualWeight

Order Weight

ItemsTotal


ItemsTax


ShippingChargesPaid


Total

Total for the whole order

Comments


BillingAddress


ShippingAddress


@Model.ProcessLineBreaks(item.Name)

For long blocks of text that have line breaks


Back to Top