Data Lake Data Dictionary
Here you can download available Data Lake data dictionaries.
Data Dictionary 2.0
Download v2.0Data attributes
Expand the lists below to see which data attributes are included in the Data Lake.
Configuration Data Mappings
| Elastic Data Field | Elastic Data Type | SQL Data Source | Description |
|---|---|---|---|
| Account Count by Carrier | integer | Number of Accounts by Carrier | |
| Address Validation | boolean | dbo.Carriers.AddressValidation | |
| Api User Count | integer | Count based on [User Api Keys] | |
| App Last Used Date | text | Data not provided at the moment | |
| App Type | text | Data not provided at the moment | |
| Application Base Name | text | dbo.Applications | based on dbo.Applications.AppXml |
| Application Enabled | boolean | dbo.Applications.Enabled | |
| Application Name | text | dbo.Applications.Name | |
| Application Version | text | dbo.Applications | based on dbo.Applications.AppXml |
| Apps Configured | array of objects | ||
| Authentication Mode | text | dbo.Authentication Settings.Value | |
| AV Carrier Configured | boolean | UPSAV or PBAV then true | |
| AV Carrier Type | text | UPS, PB or both | |
| Bundle/Tier Type | text | Data not provided at the moment | |
| Carrier Code | text | dbo.Carriers.CarrierCode | |
| Carrier Name | text | dbo.Carriers.CarrierName | |
| Configured Outputs | array of objects | ||
| Consolidate | boolean | dbo.Carriers.Consolidate | |
| Contact Name | text | Data not provided at the moment | |
| Creation Request Date | date | Data not provided at the moment (0001-01-01T00:00:00) | |
| Custom Data Sources | text | Data not provided at the moment | |
| Customer Name | text | The customer name from the license | |
| Default Address Validation | boolean | dbo.Carriers.DefaultAddressValidation | |
| Display | boolean | dbo.Carriers.Display | |
| eCertified | boolean | ||
| eCertified or eRR Configured | boolean | Indicates whether is either eCertified or eRR Configured has configured in Tenant | |
| Edit Shipment Before Days | integer | dbo.Carriers.EditShipmentBeforeDays | |
| Enabled Carrier Count | integer | Number of Carriers enabled | |
| Enabled Carriers | array of objects | ||
| Enabled Region | text | dbo.Carriers.EnabledRegion | |
| EOD Manifest Symbol | text | dbo.Carriers.EODManifestSymbol | |
| eRR configured | boolean | ||
| External Carrier Identifier | text | db.Invoice Carriers.ExternalCarrierIdentifier | |
| Forecast Transactions | text | Data not provided at the moment | |
| HazMat Enabled | boolean | Tenant Details | |
| ID | text | The unique identifier of a JSON document within the Data Lake. TenantID + yyyy-MM-dd | |
| International Label Symbol | text | dbo.Carriers.InternationalLabelSymbol | |
| International Origins Count | integer | Data not provided at the moment | |
| Invoice Carrier Name | text | db.Invoice Carriers.InvoiceCarrierName | |
| Is EDI | boolean | dbo.Carriers.IsEDI | |
| Is LTL | boolean | dbo.Carriers.IsLtl | |
| Label Symbol | text | dbo.Carriers.LabelSymbol | |
| Licensed Carrier Count | integer | Data not provided at the moment | |
| Location Count | integer | Count based on Locations | |
| Merchant Rating | boolean | dbo.Carriers.MerchantRating | |
| Output Base Type | text | dbo.Output Base Types.Description | |
| Output Device | text | dbo.Output Devices.Description | |
| Output Format | text | dbo.Output Formats.Description | |
| Output Stock Description | text | dbo.Output Stocks.Description | |
| Output Stock Height | double | dbo.Output Stocks.Height | |
| Output Stock Width | double | dbo.Output Stocks.Width | |
| Output Type | text | dbo.Output Types.Description | |
| Outputs Config | text | Data not provided at the moment | |
| Partner Customer ID | text | The unique identifier of a customer from a partners perspective if one has been provided | |
| Pierbridge Customer Account Number | text | The unique identifier of a customer from Pierbridge’s perspective | |
| Point-To-Point | boolean | dbo.Carriers.PointToPoint | |
| Product Version | text | Data not provided at the moment | |
| Requires End Of Day | boolean | dbo.Carriers.RequiresEndOfDay | |
| Reseller Name | text | ||
| Reseller Organization ID | text | Reseller's organization unique identifier from Pierbridge's perspective | |
| Reserved Characters | text | dbo.Carriers.ReservedCharacters | |
| Return Flag Support | integer | dbo.Carriers.ReturnFlagSupport | |
| Ring | text | Data not provided at the moment | |
| Stamps Configured | boolean | Count taken from Stamp table. ["StampCount"] > 0 | |
| Symbol | text | dbo.Carriers.Symbol | |
| Tenant Identifier | text | The unique identifier of a tenant using its FQDN | |
| Tenant Live Date | date | Data not provided at the moment (0001-01-01T00:00:00) | |
| Test or Live mode | text | Server.Live | |
| Third Parties Configuration | array of objects | ||
| Third Party Account | text | dbo.Accounts.Description | |
| Third Party Address 1 | text | dbo.Addresses.Address1 | |
| Third Party Address 2 | text | dbo.Addresses.Address2 | |
| Third Party Address 3 | text | dbo.Addresses.Address3 | |
| Third Party Broker Reference | text | dbo.Third Parties.BrokerReference | |
| Third Party City | text | dbo.Addresses.City | |
| Third Party Contact | text | dbo.Third Parties.Contact | |
| Third Party Country | text | dbo.Addresses.CountryCode | |
| Third Party Email | text | dbo.Third Parties.Email | |
| Third Party Identifier | integer | Data not provided at the moment | |
| Third Party Organization | text | dbo.Third Parties.Organization | |
| Third Party Phone | text | dbo.Third Parties.Phone | |
| Third Party Postal Code | text | dbo.Addresses.PostalCode | |
| Third Party Region | text | dbo.Addresses.Region | |
| Third Party Tax Identifier | text | dbo.Third Parties.TaxIdentifier | |
| Third Party Tax Identifier Type | integer | dbo.Third Parties.TaxIdentifierTypeID | |
| Tracking URL | text | dbo.Carriers.TrackingUrl | |
| Unique Identifier | keyword | dbo.Carriers.UniqueIdentifier | |
| User Account Code | text | dbo.Account Codes.Code | |
| User Company Code | text | dbo.Company Codes.Code | |
| User Cost Center | text | dbo.Cost Centers.Name | |
| User Count | integer | Count based on Users | |
| User Default App | text | dbo.Applications.Name | |
| User Department | text | dbo.Users.DepartmentName | |
| User Email | text | dbo.Users.Email | |
| User Full Name | text | dbo.Users.FullName | |
| User Job Title | text | dbo.Users.JobTitle | |
| User Location | text | dbo.Locations.Description | |
| User Name | text | dbo.Users.UserName | |
| User Phone | text | dbo.Users.Phone | |
| User Profile | text | dbo.Profiles.Description | |
| User Role | text | dbo.Users.Role | |
| Users | array of objects | ||
| Versions of Apps Configured | array of objects | Data not provided at the moment | |
Shipping Mappings
| Elastic Data Field | Elastic Data Type | SQL Data Source | Description |
|---|---|---|---|
| Accessorial Cost | double | dbo.Packages.AccessorialCost | |
| Account | text | dbo.Accounts.Description | |
| Account Code | text | dbo.Shipments.AccountCode | |
| Address Modified | boolean | dbo.Shipments.AddressModified | |
| AES Transaction Number | text | dbo.Shipments.AESTransactionNumber | |
| Application Name | text | dbo.Transaction Source Applications.ApplicationName | |
| ASN Sent | boolean | dbo.Shipments.ASNSent | |
| Attention To | text | dbo.Packages.AttentionTo | |
| B13A Transaction Number | text | dbo.Shipments.B13ATransactionNumber | |
| Billing Payer Account | text | dbo.Payers.AccountNumber | |
| Billing Payer Address1 | text | dbo.Payers.Address1 | |
| Billing Payer Address2 | text | dbo.Payers.Address2 | |
| Billing Payer Address3 | text | dbo.Payers.Address3 | |
| Billing Payer City | text | dbo.Payers.City | |
| Billing Payer Contact | text | dbo.Payers.ContactName | |
| Billing Payer Country | text | dbo.TranslatedCountries.Name | |
| Billing Payer Email | text | dbo.Payers.Email | |
| Billing Payer Organization | text | dbo.Payers.Organization | |
| Billing Payer Phone | text | dbo.Payers.Phone | |
| Billing Payer Postal Code | text | dbo.Payers.PostalCode | |
| Billing Payer Region | text | dbo.Payers.Region | |
| Billing Payer Tax Identifier | text | dbo.Payers.TaxIdentifier | |
| Billing Payer Type | text | dbo.Payer Types.Description | |
| BoL Number | text | dbo.Shipments.BoLNumber | |
| Broker ID | integer | dbo.Shipments.BrokerID | |
| Broker Notification | boolean | dbo.Shipments.BrokerNotification | |
| Broker Reference | text | dbo.Shipments.BrokerReference | |
| Browser Type | text | dbo.Shipments.BrowserType | |
| Carrier | text | dbo.Shipments.CarrierName | |
| Carrier Package Type | text | dbo.Carrier Package Types .Description | |
| Carrier Package Type Symbol | text | dbo.Carrier Package Types.Symbol | |
| Carrier Service | text | dbo.Shipments.CarrierServiceName | |
| Carrier Service Alternate Count | integer | dbo.Shipments.CarrierServiceAlternateCount | |
| Carrier Service Is International | boolean | dbo.Carrier Services.IsInternational | |
| Carrier Service Symbol | text | dbo.Carrier Services.Symbol | |
| Carrier Service Type | text | dbo.Carrier Service Types.Description | |
| Charge Base Type | text | dbo.Charge Base Types.Description | |
| Charge Rate Weight | double | dbo.Charges.RateWeight | |
| Charge Type | text | dbo.Charge Types.Description | |
| Charge Value | double | dbo.Charges.ChargeValue | |
| Charges | array of objects | ||
| Client | text | dbo.Shipments.Client | |
| Client Identifier | text | dbo.Shipments.ClientIdentifier | |
| COD | boolean | dbo.Packages.COD | |
| COD Package Reference | text | dbo.Packages.CODPackageReference | |
| COD Value | double | dbo.Packages.CODValue | |
| CODRemittance Address ID | integer | dbo.Shipments.CODRemittanceAddressID | |
| Commitment Date | date | dbo.Shipments.CommitmentDate | |
| Company Code | text | dbo.Shipments.CompanyCode | |
| Confirmation Email Sent | boolean | dbo.Packages.ConfirmationEmailSent | |
| Consolidated Shipment ID | integer | dbo.Shipments.ConsolidatedShipmentID | |
| Content Description | text | dbo.Packages.ContentDescription | |
| Cost Center | text | dbo.Cost Centers.Name | |
| Cost Center Code | text | dbo.Shipments.CostCenterCode | |
| Country Code | text | dbo.Shipments.CountryCode | |
| Cubic | double | dbo.Packages.Cubic | |
| Custom Carrier Code | text | dbo.Shipments.CustomCarrierCode | |
| Customer Accessorial Cost | double | dbo.Packages.CustomerAccessorialCost | |
| Customer Carrier Services ID | integer | dbo.Shipments.CustomerCarrierServicesID | |
| Customer DUNS | text | dbo.Shipments.CustomerDUNS | |
| Customer Freight Cost | double | dbo.Packages.CustomerFreightCost | |
| Customer ID | integer | dbo.Shipments.CustomerID | |
| Customer Location Identifier | text | dbo.Shipments.CustomerLocationIdentifier | |
| Customer Name | text | The customer name from the license | |
| Customer Net Rate Cost | double | dbo.Packages.CustomerNetRateCost | |
| Customer Other Cost | double | dbo.Packages.CustomerOtherCost | |
| Customer Total Cost | double | dbo.Packages.CustomerTotalCost | |
| Customer Vendor Number | text | dbo.Shipments.CustomerVendorNumber | |
| Delivery Confirmation | boolean | dbo.Packages.DeliveryConfirmation | |
| Dimensions UOM | text | dbo.Shipments.DimensionUOM | |
| Do Not Batch Track | boolean | dbo.Packages.DoNotBatchTrack | |
| Documents Only | boolean | dbo.Packages.DocumentsOnly | |
| Dry Ice Weight | double | dbo.Packages.DryIceWeight | |
| Duty Payer Account | text | dbo.Payers.AccountNumber | |
| Duty Payer Address1 | text | dbo.Payers.Address1 | |
| Duty Payer Address2 | text | dbo.Payers.Address2 | |
| Duty Payer Address3 | text | dbo.Payers.Address3 | |
| Duty Payer City | text | dbo.Payers.City | |
| Duty Payer Contact | text | dbo.Payers.ContactName | |
| Duty Payer Country | text | dbo.TranslatedCountries.Name | |
| Duty Payer Email | text | dbo.Payers.Email | |
| Duty Payer Organization | text | dbo.Payers.Organization | |
| Duty Payer Phone | text | dbo.Payers.Phone | |
| Duty Payer Postal Code | text | dbo.Payers.PostalCode | |
| Duty Payer Region | text | dbo.Payers.Region | |
| Duty Payer Tax Identifier | text | dbo.Payers.TaxIdentifier | |
| Duty Payer Type | text | dbo.PayerTypes.Description | |
| End of Day | boolean | dbo.Shipments.EoD | |
| End Of Day Identifier | text | dbo.End Of Day.Identifier | |
| Estimated Delivery Code | text | dbo.Shipments.EstimatedDeliveryCode | |
| Estimated Delivery Day Code | text | dbo.Shipments.EstimatedDeliveryDayCode | |
| Execution Disabled | boolean | dbo.Shipments.ExecutionDisabled | |
| Export Transaction Number | text | dbo.Shipments.ExportTransactionNumber | |
| External Carrier Identifier | text | dbo.Shipments.ExternalCarrierIdentifier | |
| External Option Identifier | text | dbo.Shipments.ExternalOptionIdentifier | |
| External Package Status | text | dbo.Shipments.ExternalPackageStatus | |
| External Package Type Identifier | text | dbo.Packages.ExternalPackageTypeIdentifier | |
| External Quote Identifier | text | dbo.Shipments.ExternalQuoteIdentifier | |
| External Receiver ID | text | dbo.Shipments.ExternalReceiverID | |
| External Service Identifier | text | dbo.Shipments.ExternalServiceIdentifier | |
| Formatted Barcode | text | dbo.Packages.FormattedBarcode | |
| Freight Class | text | dbo.Packages.FreightClass | |
| Freight Cost | double | dbo.Packages.FreightCost | |
| Freight Fowarder ID | integer | dbo.Shipments.FreightFowarderID | |
| Full Intelligent Mail Package Barcode | text | dbo.Packages.FullIntelligentMailPackageBarcode | |
| GeoCode | geo_point | Based on delivery address data: ShipmentAddress1 ShipmentAddress2, ShipmentCity, ShipmentRegion, ShipmentPostalCode, CountryCode | |
| Hazardous Additional Handling | text | dbo.Shipments.HazardousAdditionalHandling | |
| Hazardous Instructions | text | dbo.Shipments.HazardousInstructions | |
| Hazardous Other Required Information | text | dbo.Shipments.HazardousOtherRequiredInformation | |
| Hazardous Package | boolean | dbo.Packages.HazardousPackage | |
| Hazardous Package Un Code | text | dbo.Packages.HazardousPackageUnCode | |
| Hazardous Packaging | text | dbo.Packages.HazardousPackaging | |
| Hazardous Packaging Quantity | integer | dbo.Packages.HazardousPackagingQuantity | |
| Hazardous Shipment | boolean | dbo.Shipments.HazardousShipment | |
| Height | double | dbo.Packages.Height | |
| Hold | boolean | dbo.Packages.Hold | |
| Holder Address1 | text | dbo.PackagesHolderAddress1 | |
| Holder Address2 | text | dbo.Packages.HolderAddress2 | |
| Holder Address3 | text | dbo.Packages.HolderAddress3 | |
| Holder City | text | dbo.Packages.HolderCity | |
| Holder Country Code | text | dbo.Packages.HolderCountryCode | |
| Holder Name | text | dbo.Packages.HolderName | |
| Holder Organization | text | dbo.Packages.HolderOrganization | |
| Holder Phone | text | dbo.Packages.HolderPhone | |
| Holder Postal Code | text | dbo.Packages.HolderPostalCode | |
| Holder Region | text | dbo.Packages.HolderRegion | |
| ID | text | The unique identifier of a JSON document within the Data Lake. The identifier is formed from the concatenation of tenant FQDN, shipment ID and package ID | |
| Importer Of Record Code | text | dbo.Importer Of Record Facilities.IORCode | |
| Importer Of Record Country Code | text | dbo.Importer Of Record Facilities.CountryCode | |
| Importer Of Record Description | text | dbo.Importer Of Record Facilities.Description | |
| Insert User Account Code | text | dbo.Account Codes.Code | |
| Insert User Bulk User | boolean | dbo.Users.BulkUser | |
| Insert User Company Code | text | dbo.Company Codes.Code | |
| Insert User Cost Center | text | dbo.Cost Centers.Name | |
| Insert User Default App | text | dbo.Applications.Name | |
| Insert User Department Name | text | dbo.Users.DepartmentName | |
| Insert User Email | text | dbo.Users.Email | |
| Insert User Enabled | boolean | dbo.Users.Enabled | |
| Insert User External Department Code | text | dbo.Users.ExternalDepartmentCode | |
| Insert User External Receiver Id | text | dbo.Users.ExternalReceiverId | |
| Insert User External Site ID | text | dbo.Users.ExternalSiteID | |
| Insert User External User Id | text | dbo.Users.ExternalUserId | |
| Insert User Full Name | text | dbo.Users.FullName | |
| Insert User Hazardous Enabled | boolean | dbo.Users.HazardousEnabled | |
| Insert User Hazardous Show Notification | boolean | dbo.Users.HazardousShowNotification | |
| Insert User IPAddress | text | dbo.Users.IPAddress | |
| Insert User Is Group | boolean | dbo.Users.IsGroup | |
| Insert User Job Title | text | dbo.Users.JobTitle | |
| Insert User Localization | text | dbo.Localizations.Description | |
| Insert User Location | text | dbo.Locations.Description | |
| Insert User Phone | text | dbo.Users.Phone | |
| Insert User Profile | text | dbo.Profiles.Description | |
| Insert User Role | text | dbo.Users.Role | |
| Insert User Tax Identifier | text | dbo.Users.TaxIdentifier | |
| Insert User Timezone | text | dbo.TimezoneValues.TimezoneName | |
| Insurance | boolean | dbo.Packages.Insurance | |
| Insurance Value | double | dbo.Packages.InsuranceValue | |
| Invoice Payer Account | text | dbo.Payers.AccountNumber | |
| Invoice Payer Address1 | text | dbo.Payers.Address1 | |
| Invoice Payer Address2 | text | dbo.Payers.Address2 | |
| Invoice Payer Address3 | text | dbo.Payers.Address3 | |
| Invoice Payer City | text | dbo.Payers.City | |
| Invoice Payer Contact | text | dbo.Payers.ContactName | |
| Invoice Payer Country | text | dbo.Payers.CountryCode | |
| Invoice Payer Email | text | dbo.Payers.Email | |
| Invoice Payer Organization | text | dbo.Payers.Organization | |
| Invoice Payer Phone | text | dbo.Payers.Phone | |
| Invoice Payer Postal Code | text | dbo.Payers.PostalCode | |
| Invoice Payer Region | text | dbo.Payers.Region | |
| Invoice Payer Tax Identifier | text | dbo.Payers.TaxIdentifier | |
| Invoice Payer Type | text | dbo.Payer Types.Description | |
| Is Manifested | boolean | dbo.Shipments.IsManifested | |
| Is Personal Shipment | boolean | dbo.Personal Shipments.ShipmentID | |
| Is Return | boolean | dbo.Shipments.IsReturn | |
| Is World Ease | boolean | dbo.Shipments.IsWorldEase | |
| Items On Pallet | integer | dbo.Packages.ItemsOnPallet | |
| Last Updated | date | ||
| Length | double | dbo.Packages.Length | |
| Linear | double | dbo.Packages.Linear | |
| Lithium Battery | boolean | dbo.Shipments.LithiumBattery | |
| Live | boolean | dbo.Shipments.Live | |
| Manifest Delivery | boolean | dbo.Shipments.ManifestDelivery | |
| Master BoL | boolean | dbo.Shipments.MasterBol | |
| Master BoL Number | text | dbo.Shipments.MasterBolNumber | |
| National Motor Freight Classification | text | dbo.Packages.NMFC | |
| Net Rate Cost | double | dbo.Packages.NetRateCost | |
| No Of Pieces | integer | dbo.Shipments.NoOfPieces | |
| Option ID | text | dbo.Shipments.OptionID | |
| Order Date | date | dbo.Shipments.OrderDate | |
| Organization | text | dbo.Shipments.Organization | |
| Origin ID | integer | dbo.Shipments.OriginID | |
| Other Cost | double | dbo.Packages.OtherCost | |
| Other Identifier | text | dbo.Packages.OtherIdentifier | |
| Package Currency Code | text | dbo.Currency Codes.Name | |
| Package History State | text | dbo.History States .Description | |
| Package Host System Updated | boolean | dbo.Packages.HostSystemUpdated | |
| Package ID | integer | dbo.Packages.ID | |
| Package Notes | text | dbo.Packages.PackageNotes | |
| Package Reference | text | dbo.PackagesPackageReference | |
| Package Reference2 | text | dbo.Packages.PackageReference2 | |
| Package Special Services | text | dbo.Special Services | SpecialServiceDescription + SpecialServiceValue |
| Package Unique Identifier | text | dbo.Packages.PackageUniqueIdentifier | |
| Partner Customer ID | text | The unique identifier of a customer from a partners perspective if one has been provided | |
| Personal Shipment Adjustments | text | dbo.Personal Shipments.Adjustments | |
| Personal Shipment Charge | double | dbo.Personal Shipments.PersonalShippingCharge | |
| Personal Shipment Total Adjusted Charge | double | dbo.Personal Shipments.TotalAdjustedCharge | |
| Personal Shipment Total Charge | double | dbo.Personal Shipments.TotalCharge | |
| Pick List Number | text | dbo.Shipments.PickListNumber | |
| Pickup Instructions | text | dbo.Shipments.PicupInstructions | |
| Pierbridge Customer Account Number | text | The unique identifier of a customer from Pierbridge’s perspective | |
| Platform | text | dbo.Shipments.Platform | |
| Postal Meter Control Sum | double | dbo.Postal Meters.ControlSum | |
| Postal Meter Description | text | dbo.Postal Meters.Description | |
| Postal Meter Firmware Version | text | dbo.Postal Meters.FirmwareVersion | |
| Postal Meter Last Access Date | date | dbo.Postal Meters.LastAccessDate | |
| Postal Meter Low Funds Alert Type ID | integer | dbo.Postal Meters.LowFundsAlertTypeID | |
| Postal Meter Low Funds Limit | double | dbo.Postal Meters.LowFundsLimit | |
| Postal Meter Model Number | text | dbo.Postal Meters.ModelNumber | |
| Postal Meter Name | text | dbo.Postal Meters.Name | |
| Postal Meter Postage Remaining | double | dbo.Postal Meters.PostageRemaining | |
| Postal Meter Serial Number | text | dbo.Postal Meters.SerialNumber | |
| Postal Meter SMI Version | text | dbo.Postal Meters.SMIVersion | |
| Postal Meter Total Spend | double | dbo.Postal Meters.TotalSpend | |
| Postal Meter User ID | integer | dbo.Postal Meters.UserID | |
| Pouch Name | text | dbo.Pouches.Name | |
| Print User Account Code | text | dbo.Account Codes.Code | |
| Print User Bulk User | boolean | dbo.Users.BulkUser | |
| Print User Company Code | text | dbo.Company Codes.Code | |
| Print User Cost Center | text | dbo.Cost Centers.Name | |
| Print User Department Name | text | dbo.Users.DepartmentName | |
| Print User Email | text | dbo.Users.Email | |
| Print User Enabled | boolean | dbo.Users.Enabled | |
| Print User External Department Code | text | dbo.Users.ExternalDepartmentCode | |
| Print User External Receiver Id | text | dbo.Users.ExternalReceiverId | |
| Print User External Site ID | text | dbo.Users.ExternalSiteID | |
| Print User External User Id | text | dbo.Users.ExternalUserId | |
| Print User Full Name | text | dbo.Users.FullName | |
| Print User Hazardous Enabled | boolean | dbo.Users.HazardousEnabled | |
| Print User Hazardous Show Notification | boolean | dbo.Users.HazardousShowNotification | |
| Print User IPAddress | text | dbo.Users.IPAddress | |
| Print User Is Group | boolean | dbo.Users.IsGroup | |
| Print User Job Title | text | dbo.Users.JobTitle | |
| Print User Localization | text | dbo.Localizations.Description | |
| Print User Location | text | dbo.Locations.Description | |
| Print User Phone | text | dbo.Users.Phone | |
| Print User Profile | text | dbo.Profiles.Description | |
| Print User Tax Identifier | text | dbo.Users.TaxIdentifier | |
| Print User Timezone | text | dbo.TimezoneValues.TimezoneName | |
| Purchase Order Number | text | dbo.Shipments.PurchaseOrderNumber | |
| Quote Broker Reference | text | dbo.Profiles.BrokerReference | |
| Rate ID | integer | dbo.Packages.RateID | |
| Rate Type | text | dbo.Rate Types.Description | |
| Receiver Email | text | dbo.Packages.ReceiverEmail | |
| Receiver Identification Number | text | dbo.Shipments.ReceiverIdentificationNumber | |
| Receiver Phone | text | dbo.Packages.ReceiverPhone | |
| Reference 1 | text | dbo.Packages.Reference1 | |
| Reference 2 | text | dbo.Packages.Reference2 | |
| Reference 3 | text | dbo.Packages.Reference3 | |
| Reference 4 | text | dbo.Packages.Reference4 | |
| Reference 5 | text | dbo.Packages.Reference5 | |
| Reference 6 | text | dbo.Packages.Reference6 | |
| Requires ASN | boolean | dbo.Shipments.RequiresASN | |
| Reseller Name | text | ||
| Reseller Organization ID | text | Reseller's organization unique identifier from Pierbridge's perspective | |
| Residential | boolean | dbo.Shipments.Residential | |
| Return Merchandise Authorization | text | dbo.Shipments.RMA | |
| Return To Address1 | text | dbo.Shipments.ReturnToAddress1 | |
| Return To Address2 | text | dbo.Shipments.ReturnToAddress2 | |
| Return To Address3 | text | dbo.Shipments.ReturnToAddress3 | |
| Return To City | text | dbo.Shipments.ReturnToCity | |
| Return To Country Code | text | dbo.Shipments.ReturnToCountryCode | |
| Return To Name | text | dbo.Shipments.ReturnToName | |
| Return To Organization | text | dbo.Shipments.ReturnToOrganization | |
| Return To Phone | text | dbo.Shipments.ReturnToPhone | |
| Return To Postal Code | text | dbo.Shipments.ReturnToPostalCode | |
| Return To Region | text | dbo.Shipments.ReturnToRegion | |
| Return Type | integer | dbo.Shipments.ReturnType | |
| Route | text | dbo.Routes.Description | |
| Routing Code | text | dbo.Shipments.RoutingCode | |
| Sales Order Number | text | dbo.Shipments.SalesOrderNumber | |
| Sender Name | text | dbo.Senders.Name | |
| Sender Receiver Related | boolean | dbo.Shipments.SenderReceiverRelated | |
| Sent By | text | dbo.Packages.SentBy | |
| Ship To Hold | boolean | dbo.Shipments.ShipToHold | |
| Ship User Account Code | text | dbo.Account Codes.Code | |
| Ship User Bulk User | boolean | dbo.Users.BulkUser | |
| Ship User Company Code | text | dbo.Company Codes.Code | |
| Ship User Cost Center | text | dbo.Cost Centers.Name | |
| Ship User Department Name | text | dbo.Users.DepartmentName | |
| Ship User Email | text | dbo.Users.Email | |
| Ship User Enabled | boolean | dbo.Users.Enabled | |
| Ship User External Department Code | text | dbo.Users.ExternalDepartmentCode | |
| Ship User External Receiver Id | text | dbo.Users.ExternalReceiverId | |
| Ship User External Site ID | text | dbo.Users.ExternalSiteID | |
| Ship User External User Id | text | dbo.Users.ExternalUserId | |
| Ship User Full Name | text | dbo.Users.FullName | |
| Ship User Hazardous Enabled | boolean | dbo.Users.HazardousEnabled | |
| Ship User Hazardous Show Notification | boolean | dbo.Users.HazardousShowNotification | |
| Ship User IPAddress | text | dbo.Users.IPAddress | |
| Ship User Is Group | boolean | dbo.Users.IsGroup | |
| Ship User Job Title | text | dbo.Users.JobTitle | |
| Ship User Localization | text | dbo.Localizations.Description | |
| Ship User Location | text | dbo.Locations.Description | |
| Ship User Phone | text | dbo.Users.Phone | |
| Ship User Profile | text | dbo.Profiles.Description | |
| Ship User Tax Identifier | text | dbo.Users.TaxIdentifier | |
| Ship User Timezone | text | dbo.TimezoneValues.TimezoneName | |
| Shipment Address 1 | text | dbo.Shipments.Address1 | |
| Shipment Address 2 | text | dbo.Shipments.Address2 | |
| Shipment Address 3 | text | dbo.Shipments.Address3 | |
| Shipment City | text | dbo.Shipments.City | |
| Shipment Currency | text | dbo.Currency Codes.Name | |
| Shipment Customer Accessorial Cost | double | dbo.Shipments.CustomerAccessorialCost | |
| Shipment Customer Freight Cost | double | dbo.Shipments.CustomerFreightCost | |
| Shipment Customer Net Rate Cost | double | dbo.Shipments.CustomerNetRateCost | |
| Shipment Customer Other Cost | double | dbo.Shipments.CustomerOtherCost | |
| Shipment Customer Total Cost | double | dbo.Shipments.CustomerTotalCost | |
| Shipment Date | date | dbo.Shipments.ShipmentDate | |
| Shipment Description | text | dbo.Shipments.ShipmentDescription | |
| Shipment Group | text | dbo.Shipment Groups.GroupReference | |
| Shipment History State | text | dbo.History States.Description | |
| Shipment History State Is Partial | boolean | dbo.Shipments.HistoryStateIsPartial | |
| Shipment Host System Updated | boolean | dbo.Shipments.HostSystemUpdated | |
| Shipment ID | integer | dbo.Shipments.ID | |
| Shipment Identifier | text | dbo.Shipments.ShipmentIdentifier | |
| Shipment Postal Code | text | dbo.Shipments.PostalCode | |
| Shipment Region | text | dbo.Shipments.Region | |
| Shipment Requisition ID | integer | dbo.Shipments.ShipmentRequistionID | |
| Shipment Special Services | text | dbo.Special Services | SpecialServiceDescription + SpecialServiceValue |
| Shipment Type | text | IsLtl + IsLocal | |
| Shipper Reference | text | dbo.PackagesShipperReference | Reference which can be added to the shipper reference field in the References |
| Shipping Key | text | dbo.Shipments.ShippingKey | |
| Shipping Notes | text | dbo.Shipments.ShippingNotes | |
| Shipping Tracking Number | text | dbo.Shipments.ShippingTrackingNumber | |
| Submitted Weight | double | dbo.Packages.SubmittedWeight | |
| Suggested Carrier Service | text | dbo.Carrier Services.Description | |
| Tenant Identifier | text | dbo.Settings.Value | The unique identifier of a tenant using its FQDN |
| Terms Of Sale Consignee Account Number | text | dbo.Shipments.TermsOfSaleConsigneeAccountNumber | |
| Terms Of Sale Type | text | dbo.Terms Of Sale Types.Description | |
| Third Party Carrier ID | integer | dbo.Shipments.ThirdPartyCarrierID | |
| Third Party Hazardous Reference | text | dbo.Shipments.ThirdPartyHazardousReference | |
| Time Log | date | dbo.Shipments.TimeLog | |
| Total Cost | double | dbo.Packages.TotalCost | |
| Total Duty Value | double | dbo.Shipments.TotalDutyValue | |
| Trailer | text | dbo.Shipments.Trailer | |
| Ultimate Consignee ID | integer | dbo.Shipments.UltimateConsigneeID | |
| Ultimate Destination Country Code | text | dbo.Shipments.UltimateDestinationCountryCode | |
| Unique Shipment ID | text | The unique identifier of a shipment transaction for a particular tenant. This identifier is formed from the concatenation of tenant FQDN and shipment ID | |
| Weight | integer | dbo.Packages.Weight | |
| Weight Exact | double | dbo.Packages.WeightExact | |
| Weight UOM | text | dbo.Shipments.WeightUOM | |
| Width | double | dbo.Packages.Width | |
| Void User Account Code | text | dbo.Account Codes.Code | |
| Void User Bulk User | boolean | dbo.Users.BulkUser | |
| Void User Company Code | text | dbo.Company Codes.Code | |
| Void User Cost Center | text | dbo.Cost Centers.Name | |
| Void User Department Name | text | dbo.Users.DepartmentName | |
| Void User Email | text | dbo.Users.Email | |
| Void User Enabled | boolean | dbo.Users.Enabled | |
| Void User External Department Code | text | dbo.Users.ExternalDepartmentCode | |
| Void User External Receiver Id | text | dbo.Users.ExternalReceiverId | |
| Void User External Site ID | text | dbo.Users.ExternalSiteID | |
| Void User External User Id | text | dbo.Users.ExternalUserId | |
| Void User Full Name | text | dbo.Users.FullName | |
| Void User Hazardous Enabled | boolean | dbo.Users.HazardousEnabled | |
| Void User Hazardous Show Notification | boolean | dbo.Users.HazardousShowNotification | |
| Void User IPAddress | text | dbo.Users.IPAddress | |
| Void User Is Group | boolean | dbo.Users.IsGroup | |
| Void User Job Title | text | dbo.Users.JobTitle | |
| Void User Localization | text | dbo.Localizations.Description | |
| Void User Location | text | dbo.Locations.Description | |
| Void User Phone | text | dbo.Users.Phone | |
| Void User Profile | text | dbo.Profiles.Description | |
| Void User Tax Identifier | text | dbo.Users.TaxIdentifier | |
| Void User Timezone | text | dbo.TimezoneValues.TimezoneName | |
| World Ease ID | integer | dbo.Shipments.WorldEaseID |
Data Dictionary 1.0
Download v1.0Last edited 6 December 2021
