Field Replacements in Custom Templates

ShipStation Content Team

Updated September 12, 2024 23:52

Field Replacements are a way to add content dynamically to your email or packing slip templates. Field Replacements will pull store-specific, order-specific, shipment-specific, and recipient-specific information into either the email or packing slip ShipStation creates. Once you have selected your Field Replacements, use the content buttons in the visual editor to assist with fonts, text size, and other text formatting needs.

Field Replacements are indicated by the square brackets [ ] surrounding the text in your email or packing slip editors.

To add a field replacement to a template, place your cursor where you wish the content to go and either click the field replacement button in the list or type the field replacement text into the editor exactly as it appears in the list (including the square brackets, capitals, and spaces).

To delete an existing field replacement from the template, highlight it and press Delete.

See the tables below for a list of all available field replacements for email and packing slip templates, along with a description of the information each field replacement adds to your template.

Email Field Replacements

The following table lists the field replacements available for custom email templates in ShipStation, along with a description of the information that field replacement will add to the email.

Field Replacements work the same whether you use the WYSIWYG (visual) or HTML editors.

Field Replacement	Information Added to Notification Email
[Order #]	The order number as displayed in ShipStation
[Order Date]	The order date as displayed in ShipStation
[Ship Date]	The Ship Date as displayed in ShipStation (typically the day the label is created)
[Buyer Name]	The name of the buyer on the order as displayed in ShipStation (in the Sold To field of the order), if available
[Username]	The username on the order, if available
[Payment Date]	The payment date on the order as displayed in ShipStation, if available
[Store Company Name]	The Company Name from the store's Branding settings in ShipStation
[Store Phone]	The Phone number from the store's Branding settings in ShipStation
[Store Name]	The Store Name from the Store Settings tab in ShipStation
[Store Website]	The Website information from the Branding tab in the store's settings
[Store Email]	The Email address from the Branding tab in the store's settings
[Store Logo]	The logo image uploaded to the Branding tab in the store's settings
[Shipping Service]	The shipping service selected on the order, if available
[Carrier Name]	The carrier selected on the order, if available
[Requested Shipping Service]	The requested service imported from the selling channel as displayed in ShipStation, if available
[Notes to Buyer]	The notes from the To Buyer section of the Order Details in ShipStation
[Notes from Buyer]	The notes from the Customer section of the Order Details in ShipStation
[Custom Field #1]	The notes from the Custom Field 1 section of the Order Details in ShipStation
[Custom Field #2]	The notes from the Custom Field 2 section of the Order Details in ShipStation
[Custom Field #3]	The notes from the Custom Field 3 section of the Order Details in ShipStation
[Recipient Address]	The Ship To name and address for the order
[Recipient Name]	The Ship To name for the order
[Recipient Phone]	The Ship To phone number for the order, if available
[Recipient Email]	The Ship To email address for the order, if available
[Gift Message]	The notes from the Gift Message field in the Order Details in ShipStation
[Tracking #]	The tracking number for the shipment, if available. Will be a clickable link in the shipment and delivery confirmation emails. If the Branded Tracking option is enabled for the store, the link will direct to your branded tracking page. Otherwise, it will direct to the carrier's tracking page.
[USPS Zone]	The USPS Zone based on the Ship To and Ship From postal codes (zone 1 is the zone closest to the Ship From postal code, zone 9 is the furthest away from the Ship From postal code).
[Item List]	The list of items included in the shipment
[Item List IMAGES]	Same as [Item List] but includes product images.
[Item List NOSKU]	Same as [Item List] but does not include the item SKUs.
[Item List HIDEZERO]	Same as [Item List] but ignores products with unit cost of 0.00.
[Item List SHOWOPTIONS]	Same as [Item List] but includes item options imported from the store, if available. Item Options has a 200-character limit.
[Item List EXTERNALID]	Same as [Item List] but uses Marketplace Item # instead of SKU.
[Item List SHOWCOST]	Same as [Item List] but includes unit cost.

The all-caps text for the various Item List field replacements indicates additional attributes you can add or hide for the Item List. You can combine attributes by adding multiple attributes within the [Item List] field replacement. Separate attributes with a space.

Packing Slip Field Replacements

The following table lists the field replacements available for custom packing slip templates in ShipStation, along with a description of the information that field replacement will add to the packing slip.

Item-specific Field Replacements

You can only add item-specific field replacements (like [Sku] or [Image URL]) to the Order Items section of your packing slip template. These field replacements will not be available when editing other template sections.

Field Replacement	Information Added to the Packing Slip
[Adjustment]	Any adjustments made to an item price, like coupons or discounts, if present on an order and displayed in the Order Details in ShipStation.
[Amount Paid]	The total paid amount for an order, pulled from the Total Paid field as displayed in ShipStation.
[ASIN]	The ASIN or ISBN number for an order, if available in ShipStation.
[Buyer Name]	The name of the buyer as displayed in ShipStation.
[Carrier Fee]	The postage paid (actual cost) for a label, as displayed in the Carrier Fee column in ShipStation's Shipments tab, if present when printing a packing slip.
[Carrier Name]	The name of the carrier used when a label is created for an order, if present when printing a packing slip.
[Current Date]	Will print the current date when printing the packing slip.
[Custom Field #1]	The notes from the Custom Field 1 section of the Order Details in ShipStation.
[Custom Field #2]	The notes from the Custom Field 2 section of the Order Details in ShipStation.
[Custom Field #3]	The notes from the Custom Field 3 section of the Order Details in ShipStation.
[Dimensions]	The width, length, and height of the shipment, as displayed in ShipStation if present when printing the packing slip.
[Extended Price]	The item price multiplied by the quantity of the items ordered (total cost for quantity of an individual line item).
[Extended Price Zero]	orderitem.ExtendedPrice
[Fill Sku]	The Fulfillment SKU listed in the Product Details screen for the item on the order, if present in ShipStation.
[Gift Message]	The notes from the Gift Note field in the Order Details.
[Image Url]	The URL of the item thumbnail image, if present in ShipStation.
[Import Key]	The import key for the individual order (in most cases, this will be the same as the order number).
[Internal Notes]	The notes from the Internal Notes field in the Order Details.
[Item Options]	The item options listed for each item, as displayed in the Order Details. This field replacement lists the item options in a horizontal line separated by a comma. Item Options has a 200-character limit (applies to all item option field replacements).
[Item Options Linebreak]	The item options listed for each item, as displayed in the Order Details. This field replacement adds a line break between each item so it prints as a list, instead of a single line.
[Item Options Without Replacement]	Same as the above linebreak option, but with greater line separation.
[Item Title]	Uses the item name imported from the selling channel, unless Override the imported name is selected in the Product Details, in which case it prints what is in the Product Details Name field.
[Items Total]	The total sum of all ordered items (that is, the subtotal)
[Marketplace Item #]	The External ID for an item (applies only to eBay)
[Notes from Buyer]	The notes from the Notes From Buyer field in the Order Details screen.
[Notes to Buyer]	The notes from the Notes To Buyer field in the Order Details screen.
[Order #]	The order number as displayed in ShipStation.
[Order Date]	The order date as displayed in ShipStation.
[Order ID]	The Order ID sent to ShipStation from the selling channel (visible via ShipStation's API)
[Order Total]	The total of the entire order including shipping and tax.
[Package Type]	The package type selected for the order's shipment, if available.
[Packing Slip Message]	The text entered into the Packing Slip Footer field in the store's Packing Slip Settings.
[Payment Date]	The payment date as displayed in ShipStation.
[Product Description]	The product description field from the Product Record in ShipStation.
[Product Location]	The value set in the `Product Details > Inventory tab > Location field`. Items must be allocated on the shipment for the value to print on the packing slip correctly. Not available in ShipStation Legacy.
[Product Name]	Prints the name saved in the Product Details for the item in ShipStation instead of the name imported from the selling channel.
[Product Sku]	When using alias SKUs: instead of printing the imported SKU, it prints the SKU for the alias-linked Product Record. If not using alias SKUs, functions like [Sku]. Does not currently support showing Product Bundle SKUs. Use the [Sku] field replacement.
[Quantity]	The quantity of the item ordered.
[Recipient Address]	The recipient's Ship To address with 2-digit country code.
[Recipient Address Full Country]	Same as [Recipient Address] but uses the full country name instead of the 2-digit country code.
[Recipient Company]	The recipient company name, if present.
[Recipient Email]	The recipient's email address, if present.
[Recipient Name And Company]	Combines the Ship To name and company.
[Recipient Name]	The Ship To name.
[Recipient Phone]	The Ship To phone number, if present.
[Requested Shipping Service]	The requested service imported from the selling channel as displayed in ShipStation, if available.
[Scan Order #]	The order number without any dashes, typically used for barcodes.
[Ship By Date]	The Ship By Date on the order, if present in ShipStation.
[Ship Date]	The ship date for the label created on the shipment, if present when printing the packing slip.
[Shipping Paid]	The amount the customer paid for shipping at checkout.
[Shipping Service]	The shipping service selected for the shipment, if present when printing the packing slip.
[Sku]	The SKU imported from the selling channel, as displayed in the Order Details. If the order includes a Product Bundle, the [Sku] field replacement will honor the Show bundle on packing slip setting (in the Product Details).
[Store Company Name]	The Company Name from the Branding tab in the store's settings.
[Store Email]	The Email address from the Branding tab in the store's settings.
[Store Logo]	The logo image uploaded to the Branding tab in the store's settings. Must be used in the image URL within an <img> tag. For example: <div> <img src="http://images.ShipStation.com/[Store Logo]"> </div>
[Store Name]	The Store Name from the Branding tab in the store's settings.
[Store Phone]	The Phone number from the Branding tab in the store's settings.
[Store Website]	The Website information from the Branding tab in the store's settings.
[Tax Paid]	The tax paid as displayed in ShipStation.
[Total Quantity]	Total sum of all item quantities on the order.
[Total Quantity Without Adjustments]	Same as [Total Quantity] but excludes any adjustment items.
[Total Quantity Without ZeroDollarItem]	Same as [Total Quantity] but excludes items with a Unit Price of 0.00.
[Total Quantity Without Adjustments and ZeroDollarItems]	Same as [Total Quantity] but excludes both adjustments and items with Unit Price of 0.00.
[Tracking #]	The Tracking Number of the shipment, if present when printing the packing slip.
[TrackingURL]	Adds a link to the tracking page.
[Unit Price]	The unit price of the individual line item.
[UPC]	The UPC of the item, if available in ShipStation.
[Username]	The username of the buyer, as displayed in ShipStation.
[Warehouse Address]	The Ship From Location address used for the shipment.
[Warehouse Company]	The Company name from the Ship From Location address used for the shipment.
[Warehouse Country]	The country for the Ship From Location address.
[Warehouse Location]	The Warehouse Location field as set in the Product Details under the Shipping tab. Does not display inventory warehouse location.
[Warehouse Name]	The name field for the Ship From Location address used for the shipment.
[Weight]	The weight value for the shipment, if available when printing the packing slip.

Extra Field Replacements

ShipStation lists most of the available field replacements in the Field Replacements drop-down, but there are a few available field replacements not listed there. If you wish to use a field replacement listed above but it is not present as a button in the editor, you can manually type it into your template instead.

Be sure to type it in exactly as it appears in the list above, including the square brackets, spaces, and upper or lower case letters.

Field Replacements in Custom Templates

Email Field Replacements

Packing Slip Field Replacements

Item-specific Field Replacements

Extra Field Replacements

Share this article

Didn't find what you were looking for?