MercuryGate Field Mapping Details
This article summarizes the field mapping of Navix fields to MercuryGate's XML Files for Invoices and Document Links
Invoice XML Mapping
| <service-request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Web-XMLInvoiceParser.xsd"> | |
| <service-id>ImportWeb</service-id> | Static: 'ImportWeb' |
| <request-id>12345</request-id> | |
| <timing>false</timing> | |
| <data> | |
| <WebImport> | |
| <WebImportHeader> | |
| <FileName>UniqueFileName.xml</FileName> | |
| <Type>WebImportXMLCarrierInvoice</Type> | Static: 'WebImportXMLCarrierInvoice' |
| <UserName>NAVIXLOADID</UserName> | Our customers need to create a user named "NAVIXLOADID" |
| </WebImportHeader> | |
| <WebImportFile> | |
| <MercuryGate> | |
| <Header> | |
| <DocTypeID>FreightBill</DocTypeID> | Static: 'FreightBill' |
| </Header> | |
| <FreightBill action="Add"> | Static: "Add" |
| <ReferenceNumbers> | |
| <ReferenceNumber type="Load ID" isPrimary="true">LD3497</ReferenceNumber> | Order Number |
| <ReferenceNumber type="SCAC">SCAC</ReferenceNumber> | SCAC (if we have it) |
| <ReferenceNumber type="PO Number">653236</ReferenceNumber> | Ignore |
| </ReferenceNumbers> | |
| <BillTo> | |
| <Address type="Bill To"> | Bill To Location |
| <LocationCode>Location Code Sample</LocationCode> | Ignore |
| <Name>Sample Name</Name> | Bill To Name |
| <AddrLine1>Sample Address</AddrLine1> | Bill To Addr1 |
| <City>Sample City</City> | Bill To City |
| <StateProvince>Sample State</StateProvince> | Bill To State |
| <PostalCode>Sample Zip</PostalCode> | Bill To Zip |
| <CountryCode>Sample Country</CountryCode> | Bill To Country |
| </Address> | |
| </BillTo> | |
| <Packages> | |
| <Package> | |
| <ItemGroups> | This is Line Items- Loop lineItems |
| <ItemGroup> | |
| <LineItem> | |
| <ItemId>Item-1</ItemId> | orderLineItemId |
| </LineItem> | |
| <Description>Line Haul</Description> | lineItem.description |
| <Weights> | |
| <Weight type="actual" uom="lb">315</Weight> | lineItem.weight |
| </Weights> | |
| <Quantities> | |
| <Quantity type="actual" uom="PCS">1</Quantity> | static type "actual" and uom "PCS"… lineItems.totalPieces for Quantity |
| </Quantities> | |
| </ItemGroup> | Ignore |
| </ItemGroups> | Ignore |
| </Package> | Ignore |
| </Packages> | Ignore |
| <Plan> | Ignore |
| <Events> | Ignore |
| <Event type="PICKUP"> | Ignore |
| <Dates> | Ignore |
| <Date type="actual">2/14/2018 00:00</Date> | Ignore |
| </Dates> | Ignore |
| <Address> | Ignore |
| <LocationCode>Sample Pickup Code</LocationCode> | Ignore |
| <Name>Sample Pickup Name</Name> | Ignore |
| <AddrLine1>Sample Pickup Address</AddrLine1> | Ignore |
| <City>Sample Pickup City</City> | Ignore |
| <StateProvince>Sample Pickup State</StateProvince> | Ignore |
| <PostalCode>Sample Pickup Zip</PostalCode> | Ignore |
| <CountryCode>NSample Pickup Country</CountryCode> | Ignore |
| </Address> | Ignore |
| </Event> | Ignore |
| <Event type="Drop"> | Ignore |
| <Dates> | Ignore |
| <Date type="actual">02/13/2018 00:00</Date> | Ignore |
| </Dates> | Ignore |
| <Address> | Ignore |
| <LocationCode>Sample Drop Code</LocationCode> | Ignore |
| <Name>Sample Drop Name</Name> | Ignore |
| <AddrLine1>Sample Drop Address</AddrLine1> | Ignore |
| <City>Sample Drop City</City> | Ignore |
| <StateProvince>Sample Drop State</StateProvince> | Ignore |
| <PostalCode>Sample Drop Zip</PostalCode> | Ignore |
| <CountryCode>NSample Drop Country</CountryCode> | Ignore |
| </Address> | Ignore |
| </Event> | Ignore |
| </Events> | Ignore |
| </Plan> | Ignore |
| <PriceSheets> | Ignore |
| <PriceSheet type="Carrier" isSelected="true" currencyCode="EUR"> | Ignore |
| <Weight type="actual" uom="kg">55.36</Weight> | sum of total LineItem Weights |
| <Settlement> | |
| <Total>0</Total> | |
| <InvoiceNumber>12347XXX</InvoiceNumber> | invoiceDetails.number |
| <Date type="invoice">02/19/2018 00:00</Date> | invoiceDate |
| <PaymentMethod>Prepaid</PaymentMethod> | freightChargeTerms |
| </Settlement> | |
| <ReferenceNumbers> | Ignore |
| <ReferenceNumber type="VAT Charges">99.01</ReferenceNumber> | Ignore |
| </ReferenceNumbers> | Ignore |
| <Carrier> | Carrier |
| <SCAC>KE01</SCAC> | vendor.scacCode |
| </Carrier> | |
| <Charges> | |
| <Charge sequenceNum="1" type="ITEM"> | Loop Through vendorCharges |
| <Description>Line Haul</Description> | vendorCharge.description |
| <EdiCode>XXX</EdiCode> | vendorCharge.code |
| <Amount>10.25</Amount> | vendorCharge.charge |
| <Rate>10.25</Rate> | vendorCharge.charge |
| <RateQualifier>FR</RateQualifier> | static: "FR" (Flat Rate) |
| <Weight>315</Weight> | Ignore |
| </Charge> | |
| <Charge sequenceNum="2" type="ACCESSORIAL"> | |
| <Description>Fuel Surcharge</Description> | vendorCharge.description |
| <EdiCode>FSC</EdiCode> | vendorCharge.code |
| <Amount>1</Amount> | vendorCharge.charge |
| <Rate>1</Rate> | vendorCharge.charge |
| <RateQualifier>FR</RateQualifier> | static: "FR" (Flat Rate) |
| </Charge> | |
| </Charges> | |
| </PriceSheet> | |
| </PriceSheets> | |
| </FreightBill> | |
| </MercuryGate> | |
| </WebImportFile> | |
| </WebImport> | |
| </data> | |
| </service-request> |
Document Link XML Mapping
| MercuryGate Fields | Navix |
| <?xml version="1.0" encoding="utf-8"?> | |
| <service-request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Web-XMLDocumentParser.xsd"> | |
| <service-id>ImportWeb</service-id> | Static: 'ImportWeb' |
| <request-id>12345</request-id> | |
| <timing>false</timing> | |
| <data> | |
| <WebImport> | |
| <WebImportHeader> | |
| <FileName>UniqueFileName.xml</FileName> | |
| <Type>WebImportDocumentLink</Type> | Static: 'WebImportDocumentLink' |
| <UserName>NAVIXLOADID</UserName> | Our customers need to create a user named "NAVIXLOADID" |
| </WebImportHeader> | |
| <WebImportFile> | |
| <MercuryGate> | |
| <Documents> | |
| <!-- type (optional) valid values: Document (default = Document) --> | |
| <!-- isPOD (optional) valid values: true or false (default = false) --> | |
| <!-- process (optional) valid values: add or delete (default = add) --> | |
| <Document type="Document" isPOD="true" process="add"> | type = "Document", isPOD = "true" process = "add" |
| <!-- type (optional) valid values: Shipment, Transport, Event (default = Transport) --> | |
| <!-- to attach a POD to a specific drop, use type="Event" --> | |
| <Owner type="Event"> | Static, use "Transport" |
| <!-- type (required) must match primary reference type of shipment or transport --> | |
| <PrimaryReference type="Load ID">61490</PrimaryReference> | Order Number |
| </Owner> | |
| <!-- type (optional) key value from code table LinkTypes --> | |
| <!-- dropStopNum (optional) is the sequential number of the drop event, where --> | |
| <!-- the first pickup is 1, etc. Needed when adding a POD to a load with multiple drops. --> | Ignore "dropStopNum", we're not attaching to events |
| <Link type="POD" dropStopNum="3">http://www.mercurygate.com/document.pdf</Link> | See "LinkTypes" table -> |
| <!-- Comments (optional) --> | |
| <Comments>Comments for the document.</Comments> | "Imported from Navix" |
| </Document> | |
| </Documents> | |
| </MercuryGate> | |
| </WebImportFile> | |
| </WebImport> | |
| </data> | |
| </service-request> |