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 Parcel 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 Parcel Tags


Assuming you have access to the Parcel object, you must do one of the following:


1. Prefix the object's name to the required tag

2. If the tag contains an 'Additional Sub Object', then the tag must prefix the sub-object tag and suffix the object

3. If the tag is a list type, then the tag must be looped. The sub-object tags should be nested within the loop. 

4. If the object itself is a list type, then the object must be looped. The tags and/or sub-object tags should be nested within the loop.

5. If the object itself and the sub-object are list types, then both objects must be looped. The sub-sub-objects tags and/or objects should be nested within the loop.


Here is a chart displaying these use cases.


 
SyntaxExample
1
{{Parcel.TagName}}
{{Parcel.Name}}
2
{{Parcel.TagName.SubObjectTagName}}{{Parcel.Shipment.Notes}}
3
 
<!-- {{#each Parcel.TagName}} -->
        {{SubObjectTagName}} <br />
<!-- {{/each}} -->
  		 
<!-- {{#each Parcel.ParcelOrderItems}} -->
        {{Quantity}} <br />
<!-- {{/each}} -->
  
4
 
<!-- {{#each  Parcels}} -->
        {{TagName}} <br />
<!-- {{/each}} -->
 		 
<!-- {{#each Parcels}} -->
        {{Number}} <br />
<!-- {{/each}} -->
 
  5
<!-- {{#each  Parcels}} -->
  <!-- {{#each  TagName}} -->
          {{SubObjectTagName}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->

<!-- {{#each  Parcels}} -->
  <!-- {{#each  ParcelOrderItems}} -->
          {{Number}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->


Overview


Tag Name
Description
Type
Additional Sub Object
DimensionUnit
The unit the parcel dimensions has been input as.
Text
HeightThe value of the height of the parcel that has been input.Decimal Value
IdThe id of the parcel.Guid
LengthThe value of the length of the parcel that has been input.
Decimal Value

MassUnitThe unit the parcel weight has been input as.Text
NameThe name of the parcel that has been entered on the parcel.Text
NumberThe number of the parcel.Whole Number
ParcelOrderItemsThe tags related to order items can be accessed for the order items that are allocated in the parcel.ListParcel Order Item Tags
ShipmentThe tags related to a shipment can be accessed for the shipment the parcel is on.

Shipment Tags
Weight
The value of the weight of the parcel that has been input.
Decimal Value

WidthThe value of the width of the parcel that has been input.Decimal Value