Available Placeholders

Objective

Customization of all different types of document templates:

  • Mainly used for invoices and shipping labels
  • Picklist and Stock Checklist
  • Manifest and Carrier Manifest
  • Serial Number and Credit Note
  • Product Preview
  • Consignment (approved request)

Placeholders

In general, all listed placeholders are available for all document templates (invoice, shipping label, Picklist, Checklist and Manifest). Placeholders that can only be used for shipping labels are marked with an asterisk (*).
Placeholder Description Content / Calculation
Barcode
  • Barcode to scan the tracking number
Tracking code value from order
Billing Address
  • The customer address that the bill is sent to
  • This contains the full billing address in the defined format.
Accumulated order information:

  • Customer Billing Name
  • Address 1
  • Address 2
  • Address 3
  • Address 4
  • Address 5
  • City
  • Postcode
  • Country
Billing Address 1-5
  • Contains the chosen fields of the customer address.
  • Usually addresses 1 and 2 are used for street information.
  • Additional information on the address needs to be sent from the Shop to Seller Center in order to be used.
  • Address fields 3-5 can contain any content.
Only order values for:

  • Billing Address 1
  • Billing Address 2
  • Billing Address 3
  • Billing Address 4
  • Billing Address 5
Cash on Delivery
Collection
  • Money to be collected on delivery from the customer
Sum of item prices of order when order is of the type “Cash on Delivery”
COD collectable
  • Value sent by OMS in the “cod_collectable_amount” field
No calculation, simply displays the content of the field
Consignment Data Table Used for configuring the Approved Consignment request). Available placeholders are Price, Price Excl. Vat, Product Identifier, Product Name, Quantity, Vat
Current Date
  • The date when the document was printed
  • To define the date format, please see below.

Date when the invoice is printed (format: dd-mm-YYYY

[if not otherwise configured])
Current Time
  • Time when the document was printed
  • To define the time format, please see below.
Time when the invoice is printed (format: HH:ii
if not otherwise configured])
Customer Billing
Name
  • Name of the customer that the bill is sent to
  • Order value for customer
  • Billing name (first and last)
Customer Billing
Phone
  • Phone number of the customer that the bill is sent to
  • Order value for customer
  • Phone number
Customer Billing
Phone 2
  • Alternate phone number of the customer that the bill is sent to
  • Order value for customer
  • Phone number 2
Customer Billing
Zipcode *
  • The postal code of the customer’s billing address
  • Order value for customer
  • Zip code
Customer Name
  • Name of the customer that the item is shipped to
  • Order value for customer
  • Billing name (first and last)
Customer Phone
No.
  • Phone number of the customer that the item(s) is shipped to
  • Order value for customer
  • Phone number
Customer Shipping
Name
  • Name of the customer that the item(s) is shipped to
  • Order value for customer
  • Shipping name (first and last)
Customer Shipping
Phone
  • Phone number of the customer that the item(s) is sent to
  • Order value for customer
  • Shipping phone number
Customer Shipping
Phone No. 2
  • Alternate phone number of the customer that the item(s) is sent to
  • Order value for customer
  • Shipping phone number 2
Customer Shipping
Zipcode
  • The postal code of the shipping address
  • Order value for customer
  • Shipping zip code
Invoice Date
  • Order date
Date when the invoice is printed
(format: dd-mm-YYYY
[if not otherwise configured])
Invoice Number
  • Invoice number (can be defined by the Seller)
Invoice number
(generated by Seller Center)
Last Mile Shipping Provider
  • Shipment Provider which was send from OMS based on customer location and seller location.
order value of lastMileShippingProvider
Order Comment
  • Value from parameter «Remarks» from GetOrders
Order Date
  • Date when the order was made (imported to Seller Center)
Date of the order’s creation is printed.
(format: dd-mm-YYYY
[if not otherwise configured])
Order Item Table
  • Items listed in the order (name, SKU, quantity, and price)
  • Placeholder is removed from the selectable list.
  • Old placeholder is still usable. For further information, please read here.
No longer supported
Order Item List
with Package No.
  • Items listed with package number (auto generated and sent from OMS)
  • Placeholder is removed from the selectable list.
  • Old placeholder is still usable. For further information please read here.
No longer supported
Order Item List
Extended
  • Items listed in the order (name, SKU, seller SKU, size, quantity, and price)
  • Old placeholder is still usable. For further information please read here.
No longer supported
Order Items
without Price
Information
  • Items listed in the order (name, SKU, and quantity)
  • Placeholder is removed from the selectable list. Old placeholder is still usable.
  • For further information please read here.
No longer supported
(customizable)
Order Item List
  • Defines which content should be displayed for the order item list.
  • For further information, please read here.
Placeholder Overview below
Order No.
  • Order number
Order value for order number
Order No.
Barcode
  • Barcode of the order number
Package No.
Barcodes
  • Barcode of the package number for cross docking items
Package No.
  • Auto-generated number sent from OMS

Order value of package (ID from OMS)
Package paid amount
  • Total of the paid price of all items in a package

Sum of all order items’ paid price in a package.
Portcode
(for Lazada)
  • Auto-generated number sent from OMS
Order value for portcode
Portcode Barcode
(for Lazada)
  • Barcode to scan the port code
Payment Method
  • Payment method used by the customer
Order value for payment method
Registration No./
Cedula of the Customer
(only Linio, Mobly,
Kanui, Tricae)
  • Registration number of the customer
Order value for national_registration_number
Seller Address
  • Seller address
  • Seller address (received from the Shop)
  • Company name
  • Address 1
  • Address 2
  • City
  • Zip code
  • Country
Seller Address
Zipcode
  • Zipcode information from the address of Seller
Zipcode from Seller profile
Seller Business
Address (First)
  • First line of the Seller’s business address
Seller profile’s address 1 value
Seller Business
Address (Second)
  • Second line of the Seller’s business address
Seller profile’s address 2 value
Seller Business City
  • City of the Seller’s business address
Seller profile’s city value
Seller Business
Registration Number
  • Seller’s VAT number
Seller profile’s registration number value
Seller Company
Name
  • Company name of the Seller
Seller profile’s
company name value
Seller Address
Zipcode *
  • Postal code of the Seller’s address
Seller profile’s zipcode value
Seller Logo
  • Image of logo
Seller profile logo
Seller Logo
URL
  • Image URL for Seller logo (needed for resizing image on document templates)
Seller profile logo URL
(storage of logo)
Seller Name
  • Seller’s name
Seller profile name
Seller Phone
Number
  • Seller’s telephone number
  • Seller profile value
  • Phone number
Seller Email
  • Seller’s email address
Seller profile email value
Seller VAT No.
  • Seller’s VAT number
Seller profile VAT number value
Shipping
Address
  • Address of the customer that the item(s) will be sent to
  • This contains the full billing address in the predefined format.
Accumulated order information:

  • Customer shipping name
  • Address 1
  • Address 2
  • Address 3
  • Address 4
  • Address 5
  • City
  • Postcode
  • Country
Shipping
Address 1-5
  • Contains the chosen fields of the customer address.
  • Usually addresses 1 and 2 are used for street information.
  • Additional information on the address needs to be sent from the Shop to Seller Center in order to be used.
  • Address fields 3-5 can contain any content.
Only order values for:

  • Shipping Address 1
  • Shipping Address 2
  • Shipping Address 3
  • Shipping Address 4
  • Shipping Address 5
Shipping
Costs
  • Cost of shipping for order items that are packed together in one package
SUM
(sales_order_item.shipping_fee)
Shipping Cost
on Order-Level
  • Cost of shipping for all order items of an order, regardless of the state of the order item
    • Even canceled order items are taken into account.
  •  The shipping cost is only listed on the first package.
    • Additional packages don’t have this value on them.
SUM
(sales_order_item.shipping_fee)
Shipping Provider
(for Jumia/Lazada)*
  • Assigned shipping provider for the order (e.g., DHL)
Order value of shipping_carrier
Shipping Tracking
ID (For Jumia) *
  • Tracking ID given or generated
Order value of tracking code
Subtotal
  • Cost before shipping costs are added
  • “Subsidy” is transaction.value if transaction of type subsidy (44) is related with sales_order_item.
SUM
(sales_order_item.unit_price)
+ SUM (subsidy)
Sum Items
per Package
  • Displays the sum of the number of items within a package.
Amount of items within package
Total
  • Shipping cost+ item(s) cost
SUM
(sales_order_item.paid_price
+ sales_order_item.shipping_fee
+ sales_order_item.shipping_service_cost)
Total Package
Weight
  • Weight of the product(s) in the package
SUM (sales_order_item.extra_attributes.weight)
Total Paid
Price
  • Sum of the items’ paid prices
SUM (sales_order_item.paid_price)
Total Price
in Words
  • Total price written in words
SUM
(sales_order_item.paid_price
+ sales_order_item.shipping_fee
+ sales_order_item.shipping_service_cost)
Total Product
Weight
  • Total product weight of all items
SUM (sales_order_item.weight)
Total Tax
Amount
  • Sum of all items’ tax amounts
SUM (sales_order_item.tax_amount)
Total Unit
Price
  • Total of all unit prices of the order
  • “Subsidy” is transaction.value if transaction of type subsidy (44) is related with sales_order_item.
SUM (sales_order_item.unit_price) + SUM (subsidy)
Total without
Shipping Fees
  • Cost before shipping costs are added
SUM
( sales_order_item.paid_price
+ sales_order_item.shipping_service_cost)
Total without
VAT
  • Total without VAT
  • Only displayed when registration number is available for Seller.
SUM
(paid_price + shipping_fee
+ shipping_service_cost – tax_amount)
Total without
shipping service
Cost
  • Total without including the order’s shipping service costs
SUM
(sales_order_item.paid_price
+ sales_order_item.shipping_fee)
Total without
Voucher / Wallet
Calculation
  • If customer uses voucher or wallet credits, these will be reduced from total amount.
  • Total without voucher or wallet calculation
  • “Subsidy” is transaction.value if transaction of type subsidy (44) is related with sales_order_item.
SUM
(sales_order_item.unit_price)
+ SUM (subsidy)
+ SUM (sales_order_item.wallet_credits)
Unitloads
  • Numbers of unit loads of each SKU will be always “1”
VAT Amount
  • VAT amount
  • Only displayed when registration number is available for Seller.
SUM ( tax_amount )
Voucher
  • Amount of voucher that will be deducted
Total without
Voucher
  • Total of all unit prices of all products in the order
 Package value
(Sum Unit Price)
– Venture vouchers
E.g.:
Total (Unit price of item * Quantity)
– Voucher Amount
Unit Price
excluding VAT
  • Unit price of product without tax amount
sales_order_item.paid_price – sales_order_item.tax_amount, both values are received from OMS
Wallet Amount
  • Wallet credit amount can also be separately listed in the invoice.
– SUM (sales_order_item.wallet_credits)
Zipcode Barcode
  • Barcode of the zipcode
Picklist Based
on Order Item
by Package 		{{#pick_list_by_package_items}}
Inside the loop, you can use following placeholders for each row:
{{order_nr}}: Order number
{{order_item_seller_sku}}: Seller SKU
{{order_item_title}}: Product name
{{{order_item_picture}}}: Product image, notice three brackets to not escape HTML output
{{tracking_code}}: Tracking code
{{order_item_unit_price}}: Unit price of product
{{order_item_quantity}}: Quantity of items in order and given package
{{voucher_amount}}: Discount (= voucher_amount)
{{total_price_without_shipping}}: Total without shipping (= quantity x unit price – discount)
Extra Phone Number
  • Second phone number from shipping address
Order’s value for phone 2
Barcodes:

  • 1D Barcode
  • 2D Barcode / QR Code 
{{#barcodes.type_pixelWidth_pixelHeight}}value{{/barcodes.type_pixelWidth_pixelHeight}}
  • “type”: the barcode type
    • can be C39,C128,PDF417,QRCODE
  • “pixelWidth”: the width of the black pixel used to create the barcode
  • “pixelHeight”: the height of the black pixel used to create the barcode
  • “value”: can be any other placeholder (e.g., {{order_nr}})

Note:
Any data can be used in the placeholder.

Screen Shot 2016-04-14 at 09.49.53
Example 

{{#barcodes.C39_2_32}}{{order_nr}}{{/barcodes.C39_2_32}}
  • This will create a 1D C39 barcode of the order number.

 

Order Item Table Placeholders

Placeholder Description Content/Calculation
Discount Price Discount for this particular order item
International Base Cost Base Cost are Cost, Insurance and Freight reduced by Freight Cost and International Taxes Base cost = CIF – Freight Cost – International Taxes
International CIF price  Cost, insurance and freight (CIF) is a trade term requiring the seller to arrange for the carriage of goods by sea to a port of destination, and provide the buyer with the documents necessary to obtain the goods from the carrier. CIF = Onsite price * (1- varCommission) / (1 + varCustoms)
International Custom Clearance  Cost that apply based the Commission and the onsite price Customs = var.Customs * Onsite price * (1- varCommission) / (1 + varCustoms)
International Freight Cost  Freight cost are charged based on the weight of the freight  Freight Cost = varFreight * Weight
International Taxes  International taxes are calculated as percentage of the CIF  International Taxes = varIntTaxes * CIF
Item Color Color information for this particular order item
Item Counter Serial order item number for printing (1,2,3)
Item Name Product name
Item SKU Shop SKU of the product
Item SKU Seller Seller SKU of the product
Item Variation Variation / size of the product sales_order_item.variation
Order Item ID Seller Center order item ID sales_order_item.
Package Number Seller Center package ID that the product belongs to
Paid Price Paid price of the product sales_order_item.paid_price
Price of Item Unit price of the product sales_order_item.unit_price
Quantity Quantity of the product sum of the items with same sku
Sales Price without VAT Paid price of item without VAT amount sales_order_item.paid_price – tax_amount
Serial Number Serial numbers provided by Seller for particular order item. More information can be found here.
Serial Number Barcode Barcode of the serial number
Tax Amount Tax amount for this particular order item sales_order_item.tax_amount
Tax Code MY See below for Malaysian tax values. Depends on sales_order_item.tax_percent, if it is 0, than class is SL, if it is 6 than class is S6, otherweis it is empty. We receive tax_percent from OMS.
Tax Rate sales_order_item.tax_percent, from OMS
Total Price Sum of all products prices Multiplication sales_order_item.item_price * sales_order_item.item_quantity.
Unit Price excluding VAT sales_order_item.paid_price – sales_order_item.tax_amount, both values are received from OMS
VAT Amount without Shipping VAT Calculates the tax value without the tax of shipping fee amount. unit_price – (unit_price / (1+0.01 * tax_percent))
Delivery Expected Date Adds the expected date when delivery is due. sales_order_item.promised_shipping_date

Consignment Data Table Placeholders

If you want to enable consignment document printing, please raise a TMLSD ticket. The parameter that needs to be enabled is consignment/print_document/enabled.
Placeholder Description Content/Calculation
Price Product price catalog_product.price
VAT VAT % catalog_tax_class.tax_percent
Price without VAT Product price excluding VAT catalog_product.price – (catalog_product.price * catalog_tax_class.tax_percent / 100)
Product Name Name of the Product
Product Identifier Unique product identifier (UID, EAN, etc.) catalog_product.product_identifier
Quantity Quantity of the approved items in the request

Enlarged Barcodes

Sometimes barcodes can’t be read by scanners because they are too small. In the placeholder list, there is now the option to use an enlarged barcode (meaning the height of the barcode will be enlarged).

  • Usually the height of a barcode is 1.5 cm.
  • With the enlarged option, the height can be increased or decreased by a factor of  “x” (e.g., two times larger, three times larger, etc.)
To enlarge a barcode, please create a ticket within TMLSD project within JIRA and indicate the factor by which the barcodes should be increased.

Example of enlarged barcode:

barcode_enlarged

 

Resizing of Seller Logo’s

When a Seller uploads their Seller logo to their profile, this logo can also be displayed on any document template.

  • Currently, when the logo placeholder is used, the original size of the logo is displayed.
  • To change the logo size on the document templates, use the placeholder “Seller Logo URL”
  1. Insert an image and use the placeholder “Seller Logo URL” as the image URL.
  2. Set the values for width and height.
  3. The corresponding logo will be displayed in the document template.

As HTML code, it will look like this: 

<img alt=“” src=“{{ seller_logo_url }}” style=“height:90px; width:90px” />

logo_resize

 

Format of Date Placeholders

It is possible to customize the format of the following date placeholders:

  • Current Date
  • Current Time
  • Invoice Date
  • Order Date
  • Date of Document Headline

Fill in the required format in the general settings.

Available options:

  • “Y-m-d H:i:s”
    • E.g.: 2012-03-24 17:45:12
  • “d/m/Y H:i:s”
    • E.g.: 24/03/2012 17:45:12
  • “d/m/y”
    • E.g.: 24/03/12
  • “g:i A”
    • E.g.: 5:45 PM
  • “G:ia”
    • E.g.: 05:45pm
  • “g:ia \o\n l jS F Y”
    • E.g.: 5:45pm on Saturday 24th March 2012

Note: If no custom settings are applied, the default Seller Center date format will be used.

Malaysian Tax Values for Invoices

Critical KnowledgeIf you want to enable the Malaysian placeholder, please raise a TMLSD ticket. The parameter that needs to be enabled is malaysia_placeholders/enabled.
Placeholder Description Content / Calculation
Tax Code Depends on sales_order_item.tax_percent:

  • If it is 0, then class is SL.
  • if it is 6, then class is S6.
  • Otherwise, it is empty.
Order value for tax_percent from OMS.
Unit Price plus Total Shipping Fee for MY S6 Unit price plus total shipping fee of items with tax_percent = 6 ( unit_price + shipping_fee) /1.06
Unit Price plus Total Shipping Fee for MY SL Unit price plus total shipping fee of items with tax_percent = 0 unit_price + shipping_fee
VAT Amount Sum of tax amounts of each item SUM ( tax_amount )
VAT Amount for MY S6 VAT amount for Malaysia S6

  • Calculated for items with tax_percent = 6
SUM( (0.06 / 1.06 ) * (shipping_fee + unit_price) )
VAT Amount for MY SL VAT amount for Malaysia SL
VAT Amount without Shipping VAT Malaysia specific placeholder

  • All fields are taken from sales_order_item table and received from OMS.
unit_price – (unit_price / (1+0.01 * tax_percent))

 Translation

The value from the translation editor is used for the following placeholders:

  • Payment Method
  • Shipment Provider
  • Shipping Type / Delivery Option
  • Shipment Provider Route
  • Shipment Provider Region
  • Shipment Provider Service level
Critical Knowledge

  • Translations are displayed and printed depending on the user language.
  • Shipment provider route/region/service level is only printed when configuration {{ getShipmentInformation }} is enabled.
  • Translations is only printed for the shipment label document, not for any other templates.
  • If no translation is provided, the placeholder content will display the original content.

Creation of Templates with Translations

  • Create or update the template for shipment labels.
  • Once the content is added, save the changes.
  • Preview the template.
    • This will ensure that the required translation is automatically added to the Translation Editor
  • Go to Administration > Settings > Content Management > Translation Editor
  • Search for the translation and add the required translation from the specific language(s).