Templates & Variables

Teapplix allows you to make deep customization of Pick and Packing List Templates. The template is HTML, with embedded tags that uses a template language called "ClearSilver":

www.clearsilver.net

You can use all syntax from the template language, including "if-then-else", but you can not use "include" statements.

To modify Packing/Pick List templates:

  • Go to Setup => Packing List
  • Chose "Advanced" tab
  • Modify PackingCenter.cs or PickList.cs templates using variables reference;
  • Click "Save Packing List Template"

Variables Reference

There are 3 templates that you can modify:

  • PackingHeader.cs - controls the stylesheet used for the pick and packing list
  • PackingCenter.cs - controls the per order portion of the packing list
  • PickList.cs - controls the entire pick list

Variables

For all templates, the following variables are accessible

  • skulist - list of SKUs and quantities, this is typically used for building the pick list
  • orderlist - list of all orders, this can be used to build a specialized pick list. For packing list, you don't have to loop over the order list, as each PackingCenter.cs contains one order from the orderlist
  • config - this contains config variables
  • date - Current date;

Order

Each order from orderlist contains the following info:

  • order.txn_id - Order ID
  • order.pin_type - from what marketplace is the order from. "amazon" for Amazon, "ebay" for order from eBay using eBay only mode, 'pin' or 'api' for orders from eBay under eBay + PayPal model. Other values include "buy.com", "sears", "newegg", "generic", "volusion", "3dcart", "bigcommerce", "magento", "cart"
  • order.receiver_email - identifies the account or seller id or paypal primary email address
  • order.qb_txn_number - if he order is exported to QuickBooks, or imported from QuickBooks, this field contains the Sales No. in QuickBooks

Buyer Info:

    • order.payer_email - (string) Email
    • order.address_name - (string) Recipient Name
    • order.payer_business_name - (string) Company Name

order.contact_phone - (string) Phone

Buyer Address fields:

  • order.address_street - (string) Street Address
  • order.address_street2 - (string, optional) Street Address 2
  • order.address_city - (string) City
  • order.address_state - (string) State
  • order.address_zip - (string) Zip
  • order.address_country - (string) Country
  • order.address_country_code - (string) 2 letter Country Code

Notes And Special Handling:
order.memo - (string) Notes;

Item List (each:item = order.lineitems):

  • item.item_name - (string) Item Name from the order line
  • item.item_number - (string) Item Number
  • item.item_description - (string) Item Description from the order line
  • item.quantity - (integer) Quantity
  • item.mc_gross - (float) Subtotal

Additionally, for each item in the item list, if inventory is defined and mapped to, the following parameters are available:

  • item.item_type - (integer 0 - for inventory parts, 1 - for inventory assembly, 2 - non inventory items, 3 - service, 4 - other charge, 5 - discount)
  • item.inventory_item_name - (string) mapped inventory item name
  • item.inventory_item_description - (string) inventory item description
  • item.item_category - (integer) Currently not used
  • item.supplier - (string) Supplier Name
  • item.supplier_sku - (string) SKU Known to Supplier
  • item.asin - (string) Amazon ASIN
  • item.upc - (string) UPC | EAN Number
  • item.location - (string) Location assigned in Teapplix
  • item.xref3 - (string) xref3 assigned in Teapplix
  • item.image_url_s - (string) Small image URL
  • item.image_url_l - (string) Large image URL
  • item.default_cost - (float) Cost
  • item.min_quantity - (integer) Minimum quantity before re-ordering
  • item.customs_value - (float) Value used to declare on customs form
  • item.customs_description - (string) Customs description in English, as entered in Teapplix
  • item.localized_customs_description - (string) Customs description in Chinese when shipping from Asia
  • item.harmonized_code - (string) harmonized_code to be put on customs form
  • item.mod_date - (string) Last time the item was updated in Teapplix

Order Level Totals

  • order.mc_fee - (float) Fee
  • order.mc_discount - (float) Discount
  • order.mc_shipping - (float) Shipping
  • order.tax - (float) Tax
  • order.mc_gross - (float) Total Paid

SKU

Each sku from skulist contain the following info:

  • sku.name - product name
  • sku.title - product description
  • sku.location - location
  • image_url_s - small image
  • image_url_l - large image
  • sku.qty - all the quantity needed to fill this entire list of orders
  • sku.quantity_on_hand - Actual product count in inventory
  • sku.quantity_available - Quantity available after shipping

Config

  • config.packing_list - (1/0) Display packing list
  • config.pick_list - (1/0) Display pick list
  • config.packing_xref1 - (1/0) sku
  • config.packing_xref1_barcode - (1/0) sku barcode
  • config.packing_xref2 - (1/0) location
  • config.packing_xref3 - (1/0) image or xref3
  • config.packing_txn_id_barcode - (1/0) order id barcode
  • config.packing_invoice - (1/0) $ amount
  • config.packing_memo - (1/0) memo
  • config.packing_gift - (1/0) gift messages (gift purchases will not have $ amount)
  • config.packing_signature - (1/0) Allow Teapplix footer on page bottom