This article lists the standard fields available for Package level attributes. These variables allow you to reference specific details of individual boxes within your rules.
All fields listed below must be prefixed and wrapped according to the step type you are configuring:
| ACTION | CONDITION | |
| Definition | {Package.FieldName} | @([Shipment.FieldName]) |
| Example | {Package.Status} | @([Shipment.Status]) |
WARNING: The tables in this article list the Property Name only (e.g., Status). You must manually add the correct prefix (Package or Shipment) depending on your step type.
The {Package.FieldName} syntax for Actions is exclusive to Rule Sets. Client OMRs and Markup Profiles do not support package-level actions.
NOTE: For a full guide on variable types and compatibility, see: Using Custom Variables and Expressions in OMR [Information].Basic Package Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Status | ShipmentStatus | Shipment status (Unprocessed=1, Processed=2, Failed=4, Fake=8) |  | |
| ChargeStatus | ShipmentChargeStatus | Charge status (Unprocessed=1, Processed=2, Failed=4) | | |
| LabelType | ShipmentLabelType | Label type (PDF=1, ZPL=2, EPL=3, PNG=4, CombinedPNG=5, DPL=6) | | |
| SequenceNumber | int | Sequence number within order | | |
| Description | string | Box name/description | | |
| PrintStatus | ShipmentPrintStatus? | Print status (Unprocessed=1, Printed=3) | | |
| IsValidated | bool | Shipment is validated | | |
| ProcessedOn | DateTime? | Processed date/time | | |
Tracking and Identification Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| TrackingNumber | string | Tracking number | | |
| ReturnTrackingNumber | string | Return tracking number | | |
| ShipmentStatus | string | Shipment status (Unprocessed=1, Processed=2, Failed=4, Fake=8) | | |
| DhlPackageId | string | DHL package ID | | |
| SSCC | string | SSCC code | | |
| TrackingIdType | string | Tracking ID type | | |
| FormId | string | Form ID | | |
| GroupId | string | Group ID | | |
| PoNumber | string | PO number | | |
| ExtendedTrackingNumber | string | Extended tracking number | | |
| ExtendedReturnTrackingNumber | string | Extended return tracking number | | |
| SecondaryTrackingNumber | string | Secondary tracking number | | |
| ShipmentIdentificationNumber | string | Shipment identification number | | |
Weight and Dimensions Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Weight | decimal? | Package weight (LBS) | | |
| DeclaredValue | decimal? | Declared value | | |
| DryIceWeight | decimal? | Dry ice weight | | |
| BillableWeight | decimal? | Billable weight (OUTPUT from carrier) | | |
| BillableWeightUom | string | Billable weight unit of measurement | | |
| DimensionalWeight | decimal? | Dimensional weight (OUTPUT from carrier) | | |
| DimensionalWeightUom | string | Dimensional weight unit of measurement | | |
Box Dimensions (via Box property)
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Box.Width | decimal? | Box width (inches) | | |
| Box.Height | decimal? | Box height (inches) | | |
| Box.Length | decimal? | Box length (inches) | | |
| Box.Weight | decimal? | Box weight (LBS) | | |
Shipping Charge Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| ShippingCharge | decimal? | Shipping charge (before taxes) | | |
| ShippingChargeTotal | decimal? | Shipping charge total (with taxes) | | |
| FuelSurcharge | decimal? | Fuel surcharge | | |
| BaseShippingCharge | decimal? | Base shipping charge | | |
| CollectOnDeliveryAmount | decimal? | Collect on delivery amount | | |
Tax Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Tax1Type | string | First tax type | | |
| Tax1Amount | decimal? | First tax amount | | |
| Tax2Type | string | Second tax type | | |
| Tax2Amount | decimal? | Second tax amount | | |
| Tax3Type | string | Third tax type | | |
| Tax3Amount | decimal? | Third tax amount | | |
Public Shipping Charge Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| PublicShippingCharge | decimal? | Public shipping charge | | |
| PublicShippingChargeTotal | decimal? | Public shipping charge total | | |
| PublicTax1Type | string | Public first tax type | | |
| PublicTax1Amount | decimal? | Public first tax amount | | |
| PublicTax2Type | string | Public second tax type | | |
| PublicTax2Amount | decimal? | Public second tax amount | | |
| PublicTax3Type | string | Public third tax type | | |
| PublicTax3Amount | decimal? | Public third tax amount | | |
| PublicFuelSurcharge | decimal? | Public fuel surcharge | | |
SKU Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| CustomerSKU | string | Customer SKU | | |
| WarehouseSKU | string | Warehouse SKU | | |
Label Artifact Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| LabelArtifactId | string | Label artifact ID | | |
| ReturnLabelArtifactId | string | Return label artifact ID | | |
| CodeRemittanceLabelArtifactId | string | COD remittance label artifact ID | | |
| CodeRemittanceReturnLabelArtifactId | string | COD remittance return label artifact ID | | |
| LabelPdfDownloadUrl | string | Label PDF download URL | | |
| LabelZplDownloadUrl | string | Label ZPL download URL | | |
| LabelPngDownloadUrl | string | Label PNG download URL | | |
| BillOfLadingDownloadUrl | string | Bill of Lading download URL | | |
| CommercialInvoiceDownloadUrl | string | Commercial invoice download URL | | |
| NeedLabelsDownload | bool? | Labels need download | | |
Plugin-Specific Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| IntegratorTxId | string | Integrator transaction ID | | |
| StampsTxId | string | Stamps.com transaction ID | | |
| CanparId | int? | Canpar ID | | |
| MetroSCGCartonId | string | Metro SCG carton ID | | |
| ContainerSerialNumber | int | Container serial number | | |
| RFContainerSerialNumber | string | RF Pathways container serial number | | |
| ThreePLPackageId | int? | 3PL package ID | | |
Dangerous Goods Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Batteries | bool? | Contains batteries | | |
| BatteryPackingType | BatteryPackingType? | Battery packing type | | |
| BatteryMaterialType | BatteryMaterialType? | Battery material type | | |
| BatteryRegulatorySubType | BatteryRegulatorySubType? | Battery regulatory sub type | | |
| DGISPackageKey | string | DGIS package key | | |
| FedexDangerousGoods | string | FedEx dangerous goods info | | |
| FedexExpressDangerousGoods | bool? | FedEx Express dangerous goods flag | | |
| UpsHazMat | string | UPS HazMat info | | |
| UpsHazMatPackageInformation | string | UPS HazMat package information | | |
| DgisUploadedTrackingNumber | string | DGIS uploaded tracking number | | |
Pallet Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| PalletFormattedSscc | string | Pallet formatted SSCC | | |
| PalletSSCC | string | Pallet SSCC | | |
| PalletSequenceNumber | int? | Pallet sequence number | | |
| CartonSequenceNumberInPallet | int? | Carton sequence number in pallet | | |
| CartonCountInPallet | int? | Carton count in pallet | | |
| InnerCartonQuantity | int? | Inner carton quantity | | |
Return Shipment Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| ReturnShipmentDigest | string | Return shipment digest | | |
| ReturnShipmentIdentificationNumber | string | Return shipment identification number | | |
Integrated System Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| IsWmsUpdated | bool? | Is the Integrated System scanned/updated | | |
| WmsUpdateTag | string | Integrated System update tag | | |
| WmsCloseTag | string | Integrated System close tag | | |
| WmsBoxId | string | Integrated System box ID | | |
| ApiBoxId | string | API box ID | | |
Additional Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| CommodityDescription | string | Commodity description | | |
| FreightClass | string | Freight class | | |
| SpecialHandlingType | string | Special handling type | | |
| CartonizationData | string | Cartonization data | | |
| IdempotencyKey | string | Idempotency key | | |
| DeclarationId | string | Declaration ID (for customs) | | |
| ShippingServiceOfferId | string | Shipping service offer ID (Amazon MWS) | | |
| SelectedBox | string | Selected box (for OData client) | | |
Shipment-Specific Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| Signature | SignatureOption? | Signature option (Default=0, NoSignature=1, Signature=2, AdultSignature=3, IndirectSignature=4) | | |
| MiddleMileContainerId | string | Middle mile container ID | | |
| TrackingURL | string | Tracking URL | | |
| ConsolidatorActualCarrierCode | string | Consolidator actual carrier code | | |
| ConsolidatorActualCarrierName | string | Consolidator actual carrier name | | |
| ConsolidatorActualServiceCode | string | Consolidator actual service code | | |
| ConsolidatorActualServiceName | string | Consolidator actual service name | | |
Surcharges Properties
| PROPERTY NAME | PROPERTY TYPE | DESCRIPTION | ACTIONS | CONDITIONS |
|---|---|---|---|---|
| CarrierSurcharges | Dictionary | Carrier surcharges dictionary | | |
| PublicCarrierSurcharges | Dictionary | Public carrier surcharges dictionary | | |