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


Assuming you have access to the Shipment 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.


Here is a chart displaying these use cases.


 
SyntaxExample
1
{{Shipment.TagName}}
{{Shipment.Price}}
2
{{Shipment.TagName.SubObjectTagName}}{{Shipment.ShippingLocation.City}}
3
 
<!-- {{#each Shipment.TagName}} -->
{{SubObjectTagName}} <br />
<!-- {{/each}} -->
  
 
<!-- {{#each Shipment.Orders}} -->
{{Number}} <br />
<!-- {{/each}} -->
  
4
 
<!-- {{#each  Shipment}} -->
{{TagName}} <br />
<!-- {{/each}} -->
 
 
<!-- {{#each Shipments}} -->
{{ShipDate}} <br />
<!-- {{/each}} -->
 
  5
<!-- {{#each Shipments}} -->
  <!-- {{#each TagName}} -->
          {{SubObjectTagName}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->

<!-- {{#each Shipments}} -->
  <!-- {{#each Orders}} -->
          {{Number}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->


Overview


Tag Name
DescriptionType
Additional Sub Object
BillingLocationThe tags relating to a location can be accessed for the billing location input on the shipment.

Location Tags
IdThe id of the shipment.Guid
NameThe name of the shipment that was input on the shipment.Text
NotesThe notes that were input on the shipment.Text
OrderThe tags relating to an order can be accessed for the order the shipments are on.

Order Tags
OrderId
The id of the order.Guid
OriginLocationThe tags relating to a location can be accessed for the origin location input on the shipment.

Location Tags
ParcelsThe tags relating to a parcel can be accessed for the parcel on the shipment.
ListParcel Tags
PriceThe price that has been input or calculated on the shipment.Decimal Value
ShipDateThe ship date set on the shipment date.Date/Time
ShippingLocationThe tags relating to a location can be accessed for the destination location input on the shipment.

Shipping Location Tags
TaxesThe tags relating to a taxes can be accessed for the tax rates selected on the shipment.
ListShipment Tax Tags
TrackingNumberThe tracking number that has been input on the shipment.String