Using Order Data Variables in OMR [Information]

This article lists the standard fields available for the Order object (techSHIP's processed order data). These variables allow you to reference Order attributes within your rules.

All fields listed below must be prefixed with Order. and wrapped according to the step type you are configuring:

NOTE: For a full guide on variable types and compatibility, see: Using Custom Variables and Expressions in OMR [Information].

Basic Order Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.BatchNumber	string	Batch number - unique identifier assigned to a group of orders
Order.ManifestId	string	Manifest ID - unique identifier of a manifest
Order.ServiceCode	string	Service code - indicates service (product) offered by carrier
Order.ServiceCodeDescription	string	Service code description
Order.SelectedServiceCode	string	Selected service code - secondary field to override service code from UI
Order.OriginalServiceCode	string	Original service code assigned to the order before modifications
Order.PickOrder	string	Pick order (transaction number) - unique identifier for picking process
Order.CustomerOrder	string	Customer order identifier
Order.CustomerPO	string	Customer purchase order
Order.CustomerNumber	string	Customer number - reference number for various purposes
Order.Terms	string	Terms and conditions associated with the order
Order.Sequence	int	Order sequence number in batch
Order.TrackingNumber	string	Tracking number (CSV list of distinct shipment tracking numbers)
Order.SKU	string	Stock Keeping Unit
Order.OrderType	string	Order type
Order.Department	string	Department associated with the order
Order.DCNumber	string	Distribution Center number
Order.Instruction	string	Delivery instruction for the order

Ship-To Address Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShipToName	string	Recipient's name for the shipment
Order.ShipToCompany	string	Company name to which the order is being shipped
Order.ShipToAddress1	string	Recipient's address line 1
Order.ShipToAddress2	string	Recipient's address line 2
Order.ShipToAddress3	string	Recipient's address line 3
Order.ShipToDistrict	string	District for shipment (used in some Asian countries)
Order.City	string	Ship-to city
Order.State	string	State or province
Order.Zip	string	ZIP or postal code
Order.Country	string	2-character country code (ISO-3166)
Order.ShipToPhone	string	Ship-to phone number
Order.ShipToEmail	string	Ship-to email address

Bill-To Address Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.BillToName	string	Billing recipient name
Order.BillToCompany	string	Billing recipient company
Order.BillToAddress1	string	Billing address line 1
Order.BillToAddress2	string	Billing address line 2
Order.BillToAddress3	string	Billing address line 3
Order.BillToCity	string	Billing city
Order.BillToState	string	Billing state/region
Order.BillToZip	string	Billing postal code
Order.BillToCountry	string	Billing country
Order.BillToPhone	string	Billing phone
Order.BillToEmail	string	Billing email
Order.HasBillToAddress	bool?	Whether a billing address exists

Shipper (Label-From) Address Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShipperName	string	Shipper name (label from)
Order.ShipperCompany	string	Shipper company (label from)
Order.ShipperAddress1	string	Shipper address line 1
Order.ShipperAddress2	string	Shipper address line 2
Order.ShipperAddress3	string	Shipper address line 3
Order.ShipperCity	string	Shipper city
Order.ShipperState	string	Shipper state/region
Order.ShipperZip	string	Shipper postal code
Order.ShipperCountry	string	Shipper country
Order.ShipperPhone	string	Shipper phone
Order.ShipperEmail	string	Shipper email
Order.HasShipperAddress	bool?	Whether shipper address exists

Ship-From (Induction Point) Address Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShipFromName	string	Ship-from name (induction point)
Order.ShipFromCompany	string	Ship-from company
Order.ShipFromAddress1	string	Ship-from address line 1
Order.ShipFromAddress2	string	Ship-from address line 2
Order.ShipFromAddress3	string	Ship-from address line 3
Order.ShipFromCity	string	Ship-from city
Order.ShipFromState	string	Ship-from state/region
Order.ShipFromZip	string	Ship-from postal code
Order.ShipFromCountry	string	Ship-from country
Order.ShipFromPhone	string	Ship-from phone
Order.ShipFromEmail	string	Ship-from email
Order.HasShipFromAddress	bool?	Whether ship-from address exists

Third Party Billing Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ThirdPartyBillingAccount	string	Third party billing account
Order.ThirdPartyBillingPostal	string	Third party billing postal code
Order.ThirdPartyBillingCountryCode	string	Third party billing country code
Order.ThirdPartyBillingName	string	Third party billing name
Order.ThirdPartyBillingCompany	string	Third party billing company
Order.ThirdPartyBillingAddress1	string	Third party billing address line 1
Order.ThirdPartyBillingAddress2	string	Third party billing address line 2
Order.ThirdPartyBillingAddress3	string	Third party billing address line 3
Order.ThirdPartyBillingCity	string	Third party billing city
Order.ThirdPartyBillingState	string	Third party billing state
Order.ThirdPartyBillingEmail	string	Third party billing email
Order.ThirdPartyBillingPhone	string	Third party billing phone
Order.FreightPaymentTerms	FreightPaymentTerms?	Freight payment terms (Sender/Receiver/ThirdParty/Collect)

Duty Billing Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.DutyBillingAccount	string	Duty billing account
Order.DutyBillingPostal	string	Duty billing postal code
Order.DutyBillingCountryCode	string	Duty billing country code
Order.DutyPaymentTerms	DutyPaymentTerms?	Duty payment terms (Sender/Receiver/ThirdParty/Collect)
Order.DutyCurrencyCode	string	Duty currency code (ISO 4217)
Order.DutyPaymentType	string	Duty payment type

Currency and COD Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.CODCurrencyCode	string	COD currency code (ISO 4217)
Order.CurrencyCode	string	Declared value currency code (ISO 4217)
Order.CollectOnDeliveryAmount	decimal?	Collect on delivery amount
Order.CollectOnDeliveryMethod	string	Collect on delivery payment method
Order.CollectOnDeliveryIncludeShipping	bool	Whether COD includes shipping costs
Order.CollectOnPickup	decimal?	Collect on pickup amount

Status Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.Status	OrderStatus	Processing status of the order
Order.ManifestStatus	OrderManifestStatus	Manifest status
Order.PrintStatus	OrderPrintStatus	Print status
Order.ChargeStatus	OrderChargeStatus	Charge status
Order.CallbackStatus	OrderCallbackStatus	WMS callback status
Order.MapperCallbackStatus	OrderCallbackStatus	iFlow callback status

Shipping Charge Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShippingCharge	decimal?	Total price charged by carrier (before taxes)
Order.ShippingChargeTotal	decimal?	Total price with taxes and surcharges
Order.ShippingChargeCurrencyCode	string	Shipping charge currency code
Order.CarrierCharge	decimal?	Original carrier charge (before markup)
Order.CarrierChargeTotal	decimal?	Original carrier charge total (before markup)
Order.ZoneSkippingCharge	decimal?	Middle-mile carrier charge
Order.ZoneSkippingTotal	decimal?	Middle-mile carrier charge total
Order.FuelSurcharge	decimal?	Fuel surcharge amount
Order.FeeMarkup	decimal?	Fee markup applied to shipping charge
Order.BillableWeight	decimal?	Billable weight
Order.BillableWeightUom	string	Billable weight unit of measurement
Order.DimensionalWeight	decimal?	Dimensional weight
Order.DimensionalWeightUom	string	Dimensional weight unit of measurement

Tax Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.Tax1Type	string	First tax type
Order.Tax1Amount	decimal?	First tax amount
Order.Tax2Type	string	Second tax type
Order.Tax2Amount	decimal?	Second tax amount
Order.Tax3Type	string	Third tax type
Order.Tax3Amount	decimal?	Third tax amount

Public Shipping Charge Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.PublicBaseShippingCharge	decimal?	Public base shipping charge
Order.PublicShippingCharge	decimal?	Public shipping charge (includes surcharges)
Order.PublicShippingChargeTotal	decimal?	Public shipping charge total (includes taxes)
Order.PublicTax1Type	string	Public first tax type
Order.PublicTax1Amount	decimal?	Public first tax amount
Order.PublicTax2Type	string	Public second tax type
Order.PublicTax2Amount	decimal?	Public second tax amount
Order.PublicTax3Type	string	Public third tax type
Order.PublicTax3Amount	decimal?	Public third tax amount
Order.PublicFuelSurcharge	decimal?	Public fuel surcharge

Date/Time Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShipDate	DateTime?	Manifest/ship date
Order.ProcessedOn	DateTime	Processed date timestamp
Order.DeliverBeforeDate	DateTime?	Delivery deadline date
Order.DeliverBeforeTime	TimeSpan?	Delivery deadline time
Order.FreightGuaranteeDateTime	DateTime?	Freight guarantee date/time

Service Flags and Options

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.SignatureRequired	bool	Signature required upon delivery
Order.SignatureAdult	bool	Adult signature required
Order.SignatureIndirect	bool?	Indirect signature required
Order.Residential	ThreeStateValue	Residential delivery indicator
Order.SaturdayDelivery	bool	Saturday delivery
Order.SaturdayPickup	bool	Saturday pickup
Order.HoldAtLocation	bool	Hold at location service
Order.AppointmentDelivery	bool	Appointment delivery required
Order.Insurance	bool	Insurance applied
Order.DeclaredValue	decimal?	Declared value for insurance/liability
Order.DeclaredValueType	string	Declared value type
Order.PrintReturnLabels	ThreeStateValue	Print return labels
Order.NoTracking	bool	Tracking disabled

Dangerous Goods Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.DangerousGoods	bool	Contains dangerous goods
Order.DangerousGoodsCategory	string	Dangerous goods category
Order.DangerousGoodsMode	string	Dangerous goods mode
Order.DangerousGoodsNumber	string	Dangerous goods number
Order.Batteries	bool?	Contains batteries
Order.DryIce	bool	Contains dry ice

Package Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.PackageType	string	Package type
Order.PackageTypeCode	string	Package type code
Order.Fragile	bool	Fragile package
Order.Perishable	bool	Perishable items
Order.Oversize	bool	Oversized package
Order.LargePackageIndicator	bool	Large package indicator
Order.AdditionalHandlingIndicator	bool	Additional handling required
Order.SpecialHandling	bool	Special handling required
Order.Unpackaged	bool	Unpackaged shipment
Order.MailingTube	bool	Mailing tube packaging
Order.Stackable	bool?	Pallets are stackable

Freight Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.FreightClass	string	Freight class
Order.FreightNMFCClass	string	NMFC class
Order.FreightNMFCSubClass	string	NMFC subclass
Order.FreightPricing	bool?	Freight pricing needed
Order.FreightGuaranteeType	string	Freight guarantee type
Order.FreightDirectType	string	Freight direct type
Order.LiftGateForPickUpIndicator	bool	Lift gate required for pickup
Order.LiftGateForDeliveryIndicator	bool	Lift gate required for delivery

Delivery Access Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.LimitedAccess	bool?	Limited access delivery
Order.LimitedAccessDeliveryType	string	Limited access delivery type
Order.LimitedAccessDeliveryOtherName	string	Limited access delivery other name
Order.InsideDelivery	bool?	Inside delivery required
Order.InsidePickup	bool?	Inside pickup required
Order.HandbombAtPickup	bool?	Handbombing at pickup
Order.HandbombAtDelivery	bool?	Handbombing at delivery
Order.HotelDelivery	bool?	Hotel delivery
Order.HospitalDelivery	bool?	Hospital delivery
Order.HotelPickup	bool?	Hotel pickup
Order.HospitalPickup	bool?	Hospital pickup
Order.MilitaryBaseDelivery	bool?	Military base delivery
Order.ConstructionSiteDelivery	bool?	Construction site delivery
Order.TradeShowDelivery	bool?	Trade show delivery

Age Verification Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ProofOfAge	bool	Proof of age required
Order.ProofOfAge18	bool	Proof of age 18 required
Order.ProofOfAge19	bool	Proof of age 19 required
Order.AgeVerification	int?	Age verification level

Customs Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.IsDutiable	bool?	Shipment is dutiable
Order.Dutiable	ThreeStateValue?	Dutiable indicator
Order.DocumentsOnly	bool	Shipment contains only documents
Order.ReasonForExport	string	Reason for export (SALE, GIFT, RETURN, etc.)
Order.ReasonForExportFreeForm	string	Free-form reason for export
Order.DeclarationStatement	string	Declaration statement
Order.TermsOfTrade	string	Terms of trade (CIF, FOB, etc.)
Order.CustomsInbondFreight	bool?	In-bond freight status

Regulatory Indicators

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.FCC740Indicator	bool?	FCC740 compliance indicator
Order.NaftaIndicator	bool?	NAFTA qualification indicator
Order.FDA2877Indicator	bool?	FDA2877 compliance indicator
Order.HomelandSecurity	bool?	Homeland Security clearance
Order.CrossBorderFee	bool?	Cross-border fee applies

Tax Registration Numbers

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.EoriNumber	string	EORI number (receiver)
Order.SenderEoriNumber	string	Sender EORI number
Order.BillToEoriNumber	string	Bill-to EORI number
Order.VatNumber	string	VAT number (receiver)
Order.SenderVatNumber	string	Sender VAT number
Order.SenderVatNumberType	string	Sender VAT number type
Order.BillToVatNumber	string	Bill-to VAT number
Order.UkimsNumber	string	UKIMS number
Order.SenderUkimsNumber	string	Sender UKIMS number
Order.SenderIossNumber	string	Sender IOSS number
Order.BillToIossNumber	string	Bill-to IOSS number
Order.ItnNumber	string	ITN number
Order.ImporterItnNumber	string	Importer ITN number
Order.B13AFilingOptionType	string	B13A filing option type
Order.EadMrnNumber	string	Export MRN number
Order.PidType	string	PID type
Order.PidNumber	string	PID number
Order.SenderVoecNumber	string	Sender VOEC number (for Norway)

Pickup Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.RequestPickup	bool?	Pickup request made
Order.PickupRequested	bool?	Pickup has been requested
Order.PickupConfirmationNumber	string	Pickup confirmation number
Order.PickupId	long?	Pickup ID
Order.PickupInstructions	string	Pickup instructions
Order.PickupDoorTo	string	Pickup door-to type (DD/DA/DC)

Temperature Control Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.TempFrom	int?	Lower bound of temperature range
Order.TempTo	int?	Upper bound of temperature range
Order.TempType	TempType?	Temperature control type
Order.ProtectionFromFreezing	bool?	Protection from freezing required
Order.KeepFrozen	bool?	Keep frozen required

Content Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.Food	bool?	Contains food items
Order.Alcohol	bool?	Contains alcohol
Order.Medical	bool?	Contains medical supplies
Order.Tyres	bool?	Contains tires
Order.HighValue	bool?	High-value order
Order.ContentType	string	Content type of shipment

Shipment Indicators

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ShipmentIndicationType	string	Shipment indication type (01/02)
Order.ExchangeForwardIndicator	bool	Exchange forward indicator
Order.HoldForPickupIndicator	bool	Hold for pickup indicator
Order.DropoffAtUPSFacilityIndicator	bool	Dropoff at UPS facility indicator
Order.SdlShipmentIndicator	bool	SDL shipment indicator
Order.ShipperRelease	bool?	Shipper release authorized

Reference Numbers and IDs

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.MAWBNumber	string	Master Air Waybill number
Order.AirwayBillNumber	string	Airway bill number
Order.ProNumber	string	PRO number (LTL shipments)
Order.BookingConfirmationNumber	string	Booking confirmation number
Order.LoadNumber	string	Load number
Order.CarrierProvidedNumber	string	Carrier-provided number
Order.ReturnAuthorizationNumber	string	Return authorization number
Order.ShipmentIdentificationNumber	string	Shipment identification number
Order.TransactionIdentifier	string	Transaction identifier from carrier
Order.PurchaseOrderNumber	string	Purchase order number
Order.InvoiceNumber	string	Invoice number

Drop-off Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.DropOffType	string	Drop-off type
Order.DropoffAddressPropertyType	string	Drop-off address property type
Order.DropoffAddressPropertyName	string	Drop-off address property name
Order.DropoffAddressLocation	string	Drop-off address location
Order.DropoffAddressCallbox	string	Drop-off address callbox code
Order.DropoffAddressGateCode	string	Drop-off address gate code
Order.AccessCode	string	Access code for secure entry
Order.SafePlace	string	Safe place location

Integrated System Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.WmsWaveNumber	string	WMS wave (batch) number
Order.WmsTransactionNumber	string	WMS transaction number
Order.WmsTransactionType	string	WMS transaction type
Order.WmsUpdateTag	string	WMS update tag
Order.WmsVoidTag	string	WMS void tag
Order.WmsCloseOrderTag	string	WMS close order tag
Order.WmsUpdatePriceTag	string	WMS update price tag
Order.WmsUpdateAttempts	int?	WMS update attempts count
Order.WmsCallbackError	string	WMS callback error message
Order.OrderImportSource	string	Order import source

Miscellaneous Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.ProcessingErrors	string	Processing errors encountered
Order.ProcessedBy	string	User who processed the order
Order.PrinterKey	string	Printer key for assignment
Order.DeliveryOptions	OrderDelivery?	Delivery options
Order.PremiumService	string	Premium service type
Order.PostOfficeId	string	Post office ID
Order.SkipAddressValidation	bool	Skip address validation
Order.VehicleId	string	Vehicle ID for delivery
Order.ContentsDescription	string	Contents description
Order.InsuranceDescription	string	Insurance description
Order.InsuranceProvider	string	Insurance provider
Order.Note	string	Custom note for shipment
Order.TransportationType	string	Transportation type (air/ground/ocean)
Order.ReceiverType	string	Receiver type
Order.NumOfPiecesInShipment	int?	Number of pieces in shipment
Order.DeliveryWindowID	string	Delivery window ID
Order.ReturnServiceCode	string	Return service code
Order.ReturnServiceCodeDescription	string	Return service code description
Order.Exchange	bool?	Shipment is an exchange
Order.PickAndShip	bool?	Pick and ship order
Order.PickAndReturn	bool?	Pick and return order
Order.ExWorksDelivery	bool?	Ex-works delivery
Order.MondayDelivery	bool?	Monday delivery
Order.OriginSignatureNotRequired	bool?	Origin signature not required
Order.PartiesToTransactionAreRelated	bool?	Related parties to transaction
Order.ConsequentialLoss	string	Consequential loss coverage
Order.CommercialInvoicePaymentTerms	string	Commercial invoice payment terms
Order.DeclaredValueCurrencyCode	string	Declared value currency code
Order.TracingEnabled	bool?	Tracing enabled
Order.OriginalWmsServiceCode	string	Original WMS service code

Carrier-Specific Properties

FIELD VALUE	DATA TYPE	DESCRIPTION	ACTIONS	CONDITIONS
Order.DGISShipmentKey	string	DGIS shipment key
Order.FedexDangerousGoods	string	FedEx dangerous goods info
Order.UpsDGSignatoryInfo	string	UPS dangerous goods signatory info