Getting Started


If you are new to the HTML document/canned email tag system, you can get an overview of tags, objects and loops here. 


Accessing The ShipmentTax Object


Access to this object is dependent on what document or canned email type you are trying to access the object from. Start by finding the document or canned email type you are working with from the links provided below. Follow the chart for your specified document or canned email type to see if the object is accessible, and if so, where it is located.  You may need to use a combination of loops and/or chaining to access this object. 


HTML Tags by Document Type

HTML Tags by Email Type


Accessing The ShipmentTax Tags


Assuming you have access to the ShipmentTax object, the object itself is a list type, so the object must be looped. The tags and/or sub-object tags should be nested within the loop.


The following are implementations of the ShipmentTax object that give access to the ShipmentTax tags: Taxes


Here is a chart displaying these use cases.


 
SyntaxExample

 
<!-- {{#each  ShipmentTaxType}} -->
        {{TagName}} <br />
<!-- {{/each}} -->
 		 
<!-- {{#each Taxes}} -->
        {{Rate}} <br />
<!-- {{/each}} -->
 


Overview


Tag Name
DescriptionType
NameThe name of the tax rate that has been selected on the shipment.Text
ShipmentIdThe id of the shipment.Guid
RateThe % value of the tax rate that has been selected on the shipment.Decimal Value
TotalThe total tax calculated for the selected rate on the shipment.Decimal Value