Log ind

Delivery Help Center

Integration via XML files

Avatar
Anna Isaksson
Opdateret

ESSENTIAL STANDARD ADD-ON ONLY IN THE NORDICS

Subscription plans

Integrating via XML files requires the OnlineConnect application.

OnlineConnect imports XML order files from your ERP system to nShift Delivery and reports back assigned parcel and consignment numbers.

The ERP system creates an order file with shipment information for the current order(s) and places it in OnlineConnect’s order directory. OnlineConnect reads the file and sends it to nShift Delivery.

If all shipment data is valid, OnlineConnect prints labels, shipment lists and customs documents depending on service, destination and configuration. Labels and documents are either printed directly after the order file has been sent to nShift Delivery or stored to be printed from nShift Delivery. Incomplete orders are stored for later completion.

OnlineConnect can also send back a text file with parcel and shipment numbers.

The order file should be in XML format. Please refer to the XML file specification.

Data transfer between OnlineConnect and nShift Delivery is TLS encrypted (HTTPS). The communication is secured by TLS v1.2.

Install OnlineConnect

The installation of OnlineConnect follows the standards for “Windows Installer”. The installation file is currently only available in English. However, Administration of OnlineConnect is available in several different languages.

System requirements

  • Windows 10 or higher

  • Windows Server 2016 or higher

  • Local system administrator privileges.

Download OnlineConnect.

Hvis downloaden ikke starter, opdater denne hjælpeside og prøv igen.

Run OnlineConnect

After installation, two shortcuts are created in the start menu, Administration of OnlineConnect and OnlineConnect.

OnlineConnect can be run either as a desktop application or as a Windows service.

Bemærk

Running the application in desktop mode requires that a user is logged in to the operating system console/desktop, while service mode doesn't.

OnlineConnect is designed as a server-side application and should be run accordingly, that is, as a service. It's considered best practice to have a dedicated system user account that can be used for running the application as a service. The application settings are stored in the user’s home directory which means that the user making configuration changes and running the application should be the same.

Pas på

  • The dedicated user account should be excluded from the password change policy.

  • The user should be a domain member, where applicable.

  • The user should be appointed local administrator.

  • Make sure that the user has access to necessary printers and network folders.

Administration of OnlineConnect

This application is used for administration and monitoring. OnlineConnect must be running if you want to change settings or monitor the status of the application.

Bemærk

Settings and log files are stored in the home directory of the user running the application or service.

Throughout this section, you will come across options containing “Advanced settings”. Those options are only shown if Advanced settings is selected in the Show drop-down menu.

The administration program’s user interface consists of a row of tabs.

UOC_Administration.gif

Information

The Information tab provides a brief description of what the other tabs contain.

Communication

The Communication tab contains settings for communication between your instance of OnlineConnect and your back-end system.

Clicking the Add button will open a new dialogue where you enter information about your account, file paths and printers.

Account

  • User ID and password

  • API key

    Provide the entire API key, that is, both the ID and Secret ID (also known as Combined ID or Bearer token) separated by a dash.

    Example: SE6BXKQVRGV6USOO-D3N1CVEWFOBHKAVVDWIKT7FY

The credentials will be validated if you switch tab or click OK.

Order files

Specify the path from where the order files should be fetched. You can add multiple paths with different settings.

Pas på

If you add the same path twice, make sure there is a difference in file mask, otherwise the fetching could fail.

File format is set to XML by default.

Number of seconds after editing before the file is processed is an integer that specifies how many seconds the application should wait before processing the file after the latest modification.

Check Translate DOS (OEM) characters if the files originate from an MS-DOS based application. Character set referred to here is known as OEM or CP430.

Checking Use file lock (Advanced setting) will perform a file lock even if other applications are using the file. Use with caution.

Send this folder’s direct printing to a specific printer mapping. Leave blank from automatic selection (Advanced setting) should be set if specific printer mapping for this path should be used.

Printers

Direct print is enabled by default. If disabled, shipments will be created and stored in nShift Delivery > Shipments > Stored printings where the printing is executed manually.

Guide – Printer Settings (recommended) is a step by step wizard that helps you to configure your label and document printers.

Use the Add-button to configure additional printers.

Tip

The application reads the printer list sequentially. It's useful if you have multiple printers with different label sizes. Best practice is to set the printer with a smaller label first because services that don't support smaller labels will automatically be printed on next printer in the list, ideally one supporting normal label size.

Printer mappings

You can create an alias for a printer (or printer pair). This is useful if you have multiple printing/packing stations. The alias is then used in the order file to direct the printout to a certain printing station.

Feedback report

In the Feedback report tab, settings can be made for two kinds of reports, Standard and/or Event based. Report files can be used by your beckend system in order to track a certain order’s parcel and/or consignment number or order status.

To generate a Standard report the application returns shipment information as one or multiple files and the report interval can be set in the Filter dropdown.

  • “Send feedback report only periodically” reports once every 15 minutes.

  • “Send feedback report only on direct print” reports only the printouts made via OnlineConnect.

  • “Send feedback report on direct print and periodically” reports both of the previous selections together.

Bemærk

Shipments created via Direct print will be reported both at the time of printing and in the next 15 minute interval.

File format can be either "Standard format" or "Standard format with reference" that contain order number, parcel number, consignment number, printed date and possibly reference, separated by semicolon (;).

Example: Orderno;373325381737155333;201366278689;2019-03-21 15:23:04;Reference

Event based reports are created once every 15 minutes. File contents depend on whether shipment status has been updated since last report.

You can select Naming method for both kinds of report.

  • “Date with arbitrary prefix and file extension” merges the values in the “Prefix” and “File extension” boxes with the current date and time in the middle. A new file will be created at each reporting event.

  • “Fixed name” uses the value in the “Name” box as the full name of the file. The same file will be updated at each reporting event.

  • “Internal name with arbitrary file extension” merges an internal file name with the value in the “File extension” box. A new file will be created at each reporting event.

The table below shows all available status events that can occur. Status availability may vary depending on carrier and service.

STATUS_ Presents current status of a shipment. These are not permanent.

STATUS_TRANSITION_ Presents when the status of a shipment was changed. These are permanent.

STATUS_PRINTED – "Printed"

STATUS_TRANSITION_PRINTED – The status was changed to “Printed”

STATUS_DISPATCHING – "On route"

STATUS_TRANSITION_DISPATCHING – The status was changed to “On route”

STATUS_DELIVERING – "Arrived at pickup location"

STATUS_TRANSITION_DELIVERING – The status was changed to “Arrived at pickup location”

STATUS_DELIVERED – "Delivered"

STATUS_TRANSITION_DELIVERED – The status was changed to “Delivered”

STATUS_PARTDELIVERED – "Partly delivered"

STATUS_TRANSITION_PARTDELIVERED – The status was changed to “Partly delivered”

STATUS_RETURNED – "Returned"

STATUS_TRANSITION_RETURNED – The status was changed to “Returned”

STATUS_CANCELLED – "Discarded"

STATUS_TRANSITION_CANCELLED – The status was changed to “Discarded”

Settings

Settings in this tab are general, that is, not account-specific.

Complete the Email messages section if you want the application to send email messages, for example, messages about invalid shipments, logging and other events.

The application acts as a mail client and needs valid SMTP credentials.

Pas på

Do not change anything in Advanced settings for automatic update (Advanced settings) unless instructed by nShift support.

Status

The Status tab shows a summary of the application’s activity. You can also restart the application or service from this tab and see memory usage (current/maximum/available).

Bemærk

The values in the different categories represent time intervals, that is, events occurred in the last 1, 5, 15, 30 and 60 minutes.

Events and logging

Under the Events and Logging tabs you get a more detailed view of the Status tab.

Support

Under the Support tab you find information about the application’s work, configuration and log directories. You can also create an information file that can be sent to nShift support, if requested.

Import

Import order files manually by dragging them from Windows Explorer to the box or boxes under the Import tab. The boxes correspond to the search paths created under the Communication tab.

Files can be dragged and dropped into the boxes to activate a direct import of the order file as if it were placed in the corresponding directory.

Troubleshoot OnlineConnect

Problem

Solution

Error message saying that the program can't be run on your type of processor or operating system.

You probably have a 32-bit operating system and need to download another installation program.

Please contact customer support.

Problem

Solution

Error message saying "Java runtime dll is missing".

Download and install the necessary program library. Download

XML file specification

XML file described in this document can be used as a data carrier together with several integration methods.

In case of integrity errors, such as missing XML tags, the file will be ignored. If there are errors in the variable data, such as missing information and/or invalid values, the order will be marked as invalid in nShift Delivery.

Normally, the following XML declaration is used:

 <?xml version="1.0" encoding="ISO-8859-1"?>

If Unicode is used, one of following options is valid, depending on type:

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-16"?>

There are characters that can occur in variable data that need to be entered so that the XML parser can interpret them correctly:

  • & is entered as &amp;

  • < is entered as &lt;

  • > is entered as &gt;

  • ' is entered as &apos;

  • " is entered as &quot;

For valid values and example files, please refer to the value reference guide and the example files.

Sender

The sender element contains sender's information and its occurrence is not always mandatory in a file as sender's information can be predefined in nShift Delivery. If this is the case, only a referral is needed in order file, pointing to a sender's so called Quick ID value. This referral is done in the shipment element. In cases where there are several senders and when a static structure is not possible, the information about the sender must be supplied in the order file.

The sender element consists of <sender sndid="..."> where ... is to be replaced with an attribute of your choice with any data type and length. The element must end with </sender>. Values are supplied as <val n="value name"</val>. An index of valid values can be found in the Value reference guide. Partner (carrier) information must also be supplied in those cases senders are not predefined in nShift Delivery. This is done by a nested partner element with an attribute that specifies the carrier and the element's mandatory values. Index of valid partner attributes can be found in the Help > Code lists > Services menu in nShift Delivery.

Example

<sender sndid="1">
    <val n="name">The Sender</val>
    <val n="address1">Testvägen 1</val>
    <val n="address2">Ingång C</val>
    <val n="zipcode">41118</val>
    <val n="city">GÖTEBORG</val>
    <val n="country">SE</val>
    <val n="contact">Sender's Contact</val>
    <val n="phone">031-000 00 00</val>
    <val n="email">contact@sender.xyz</val>
    <val n="sms">0700-00 00 00</val>
    <partner parid="PLAB">
        <val n="custno">0123465782</val>
    </partner>
</sender>

Receiver

The receiver element contains receiver's information and its occurrence in a file is mandatory. The receiver element consists of <receiver rcvid="...">where ... is to be replaced with an attribute value of your choice with any data type and length. The element must end with </receiver>. Values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide.

In cases where the shipment contains addon services that demand further information (for example, receiver pays, which requires the receiver's customer for the carrier), the partner information must be supplied as well. This is done by a nested partner element with an attribute that specifies the carrier and the element's mandatory values. An index of valid partner attributes can be found in the Help > Code lists > Services menu in nShift Delivery.

Example

<receiver rcvid="Customer_001">
    <val n="name">The Receiver</val>
    <val n="address1">Kundvägen 10A</val>
    <val n="address2">2 trappor</val>
    <val n="zipcode">41480</val>
    <val n="city">GÖTEBORG</val>
    <val n="country">SE</val>
    <val n="contact">Contact person</val>
    <val n="phone">031-000 00 00</val>
    <val n="email">contact@receiver.xyz</val>
    <val n="sms">0700-00 00 00</val>
</receiver>

Party

The party element contains a neutral party’s information and its occurrence is optional. The party element consists of <party ptyid="..."> where ...i s to be replaced with an attribute value of your choice with any data type and length. The element must end with </party>. Values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide. In cases where the shipment contains addon services that demand further information (for example, other payer, which requires the party’s carrier customer number), the partner information must be supplied as well. This is done by a nested partner element with an attribute that specifies the carrier and the element's mandatory values. An index of valid partner attributes can be found in Help > Code lists > Services menu in nShift Delivery.

Example

<party ptyid="Party_001">
    <val n="name">Freight Payer Company</val>
    <val n="address1">Freight Avenue 10</val>
    <val n="address2">5th floor</val>
    <val n="zipcode">41480</val>
    <val n="city">GÖTEBORG</val>
    <val n="country">SE</val>
    <val n="contact">Some person</val>
    <val n="phone">031-000 00 00</val>
    <val n="email">any@freightpayer.se</val>
    <val n="sms">0700-00 00 00</val>
</party>

Shipment

The shipment element defines the shipment itself and its presence is mandatory. Sender, receiver, delivery terms, service type and addons are defined in this element. The shipment element consists of <shipment orderno="..."> where ... is to be replaced with an attribute value of your choice with any data type and length. This attribute is not printed on shipment documents, it's unique for every shipment in a file and is searchable in nShift Delivery.

The information about the sender and receiver is supplied as <val n="from">...</val> and <val n="to">...</val>. These values refer to the sender's sndid and the receiver's rcvid attributes as mentioned in our examples earlier. Remember that sender information can also be predefined in nShift Delivery which makes the sender element obsolete. If this is the case, the value from should refer to the sender's quick ID in nShift Delivery.

Additional values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide. The element must end with </shipment>.

Prepared shipments, which are shipments originating from nShift Checkout, can be completed by using XML-file. In that case, the shipment element must contain the prepareid attribute, <shipment orderno="..." prepareid=”...”>. Once a shipment is completed, the prepare ID is deleted. However, if there is a need to keep the prepare ID for later use, it can be done by using the keeppreparedshipment attribute, <shipment orderno="..." prepareid=”...” keeppreparedshipment=”yes”>.

Service

This element contains the carrier's service code and its presence is mandatory. It's supplied as a nested element under shipment as <service srvid="..." where ... corresponds to service code. An index of valid codes can be found in Help > Code lists > Service codes - Integration menu in nShift Delivery.

The element must end with </service>.

Addon services

As mentioned earlier, addon services such as Cash On Delivery and Receiver payment to name a few, can be supplied in this element. Addons are defined as nested elements to the service element as <addon adnid="..."> where ... corresponds to the addon code. An index of valid addon codes can be found in the Help > Code lists > Service codes - Integration menu in the system.

Addons may require additional information in order to be valid. For instance, Cash On Delivery requires an amount and a payment reference. An index of valid values can be found in Value reference guide. The element must end with </addon>.

Container

The container element defines contents of the shipment, for example, number of parcels, weight and volume. This element is also nested in the shipment element. Values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide.

Parcel information can be defined in several different ways:

<container type="parcel"> defines information for each parcel individually.

<container type="parcel" measure="totals" defines information for an entire row of parcels.

<container type="parcel" partorderno="..."> defines an order number for the parcel row. Any value.

<container type="totals" measure="totals"> defines information for the entire shipment.

Pas på

Use only one parcel definition type per shipment.

Example - per parcel

<container type="parcel">
    <val n="copies">2</val>
    <val n="weight">10</val>
</container>

Shipment contains two parcels and the total weight is 20 kg (2 parcels x 10 kg).

Example - per parcel row

<container type="parcel" measure="totals">
    <val n="copies">2</val>
    <val n="weight">10</val>
</container>

Shipment contains two parcels and the total weight is 10 kg. The individual parcel weight is only assumed to be 5 kg each. Please note that the assumed individual parcel weight will not be printed on shipping documents.

Example - a shipment element

<shipment orderno="Ordernumber_1">
    <val n="from">1</val>
    <val n="to">    </val>
    <val n="reference">Shipment reference</val>
    <val n="freetext1">Text of your choice</val>
    <service srvid="P15">
    </service>
        <container type="parcel">
            <val n="copies">1</val>
            <val n="weight">10</val>
            <val n="contents">Stuff</val>
        </container>
</shipment>

Customs declaration documents

This element contains information about customs declaration documents. It's supplied as a nested element under shipment as <customsdeclaration documents="..."> where ... corresponds to the document type.

If using multiple attribute values, separate them with a pipe character (|).

Valid attribute values

PROFORMA = Proforma / commercial invoice

EDOC = ED document

PROFORMAPLABEDI = Proforma / commercial invoice by EDI and a printed copy (PostNord Sweden only)

PROFORMATNT = Proforma / commercial invoice for TNT

NOTETNT = Note for TNT

PLT = Customs information via EDI only

PNLWAYBILLEDI = I will send a separate customs declaration (EDI) (Bring only)

BRINGEDI = I will send a separate customs declaration and VAT on e-commerce (EDI) (Bring only)

CN22 = CN22POSTNORD

CN22DKPBREVINC = CN22 for Postnord DK Tracked

CN22INC = CN22 for Deutsche Post, PostNord Brev and Direct Link

CN23 = CN23POSTNORD

CN23MULTPDK = CN23 for Postnord DK Tracked

CN23PDK = CN23 for PostNord DK EMS International Express

CN23ATTACHED = Commercial invoice attached for PostNord DK EMS International Express

CN22POSTI = CN22 for Posti

CN23POSTI = CN23 for Posti

PROFORMAUPS = Proforma / commercial invoice for UPS

FEDEXP = Commercial Invoice for FEDEX

TRADEINVOICEPDK = Customs declaration for PostNord Denmark

DHLROADSTD = DHL Customs Standard

DHLAIR = DHL Express

Additional values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide. The element must end with </customsdeclaration>.

Example - customs declaration

<customsdeclaration documents="|PROFORMA|">
      <val n="senderorgno">12121212</val>
      <val n="parcelcount">1</val>
      <val n="invoicetype">PROFORMA</val>
      <val n="customsunit">SEK</val>
      <val n="impexptype">OTHER</val>
      <line measure="totals">
        <val n="statno">12121212</val>
        <val n="customsvalue">111.0</val>
        <val n="contents">Things</val>
        <val n="quantity">1</val>
        <val n="sourcecountry">SE</val>
      </line>
</customsdeclaration>

Tip

You can generate a sample file from your shipment history. Please refer to Generate integration file from history

Additional elements

There are several non-mandatory elements that can be supplied if extended functions are desired.

Meta

This element is usually inserted first in a file, directly after the declaration of the root element. The meta element can contain printer mapping, mapping to a certain print favorite etc. Values are supplied as <val n="value name">...</val>. An index of valid values can be found in the Value reference guide.

Pre-notification by email

This service is declared as part of a standalone element <ufonline> nested under the shipment element. Values are supplied as <val n="value name">...>/val>. An index of valid values can be found in Value reference guide.

Example

<ufonline>
    <option optid="enot">
        <val n="sendemail">yes</val>
        <val n="from">customerservice@mycompany.xyz</val>
        <val n="to">someone@otherside.xyz</val>
        <val n="message">Your package is on the way!</val>
    </option>
</ufonline>

The element must end with </ufonline>.

Link to Print

This service is declared as part of a standalone element <ufonline> nested under the shipment element. The declaration of the shipment element can also contain the attribute linkprintkey which is a unique value of any data type and length. This is used if it's desirable to know how the final link would look like. In this example, we will use aFg3rA as a key which would give us a link like this: https://www.unifaunonline.com/ext.uo.se.se.linkprint?key=<user-ID>&>job=aFg3rA&mode=normal

Due to the key being visible in the link, it's important that you don't use simple keys such as number sequence or similar. The recipient could change the link and print other recipient's shipping documents. Do not use empty spaces or underline characters in the link.

If linkprintkey is not supplied the system will automatically generate one.

Example

<ufonline>
    <option optid="lnkprtn">
        <val n="sendemail">yes</val>
        <val n="from">customerservice@mycompany.xyz</val>
        <val n="to">someone@otherside.xyz</val>
        <val n="message">Here is the link to your shipping documents!</val>
    </option>
</ufonline>

Consolidated shipment

This service permits continuous printing of shipping labels while the EDI message is held until the shipment is closed. A typical use case is if you have multiple orders to a certain receiver during the day and you wish to consolidate these into one single shipment. This service is declared as part of a standalone element <ufonline> nested under the shipment element.

Example

<ufonline>
    <option optid="CONSOLIDATE">
    </option>
</ufonline>

The consolidated shipment service requires the mergeid attribute in shipment element tag.

Example

<shipment orderno="Ordernummer_1" mergeid="MRG001">

Mergeid can be an alphanumeric value of your choice and should be unique for each shipment. Do not use empty spaces or underline characters. Consolidated shipments need to be closed, either manually in nShift Delivery or by supplying a closing XML file containing a control element directly under the root element.

Example

<control>
    <close>
        <val n="mergeid">MRG001</val>
    </close>
</control>

Closing a consolidated shipment triggers waybill and eventual customs declaration documents printout to preset laser printer if no printer is specified in the <val n="printer"> tag.

Value reference guide - XML

The value reference guide provides definitions and valid values for XML elements.

Meta

Declared as <meta> under the root element <data>.

Value name

Description

Type

Value

<val n="printer">

Sends the print job to defined name of printer mapping.

string

<val n="printjobnamelabel">

Defines print jobs of document type "Label".

string

Default value: "Labels"

<val n="printjobnamewaybill">

Defines print jobs of document type "Waybill".

string

Default value: "Waybills"

<val n="printjobnamecustoms">

Defines print jobs of document type "Documents", that is, customs documents, dangerous goods declarations etc.

string

Default value: “Documents”.

<val n="favorite">

Defines the print favorite in nShift Delivery which is used to auto-complete the order file if necessary.

string

<val n="autoprint">

Determines if the order file is to be sent directly to the print queue. If using XML-posting this can only be used with Link to Print, not to print physical labels.

boolean

YES, NO

<val n="test">

Used for order file testing. Prints out TEST on label and disables EDI forwarding. NOTE: Does not disable pre-notification if generated.

boolean

YES, NO

<val n="partition">

Defines the profile group where the shipment should be stored in nShift Delivery.

string

<val n="developerid">

User ID of the account creating the shipment. Normally used by partners when posting data on behalf of others.

string

Sender

Declared as <sender sndid="..."> under the root element <data>.

Value name

Description

Type

Value

<val n="name">

Name

string

<val n="address1">

Address line 1

string

<val n="address2">

Address line 2

string

<val n="housenumber">

House number. Usage depends on carrier.

string

<val n="addition">

Addition to house number, such as a letter. Usage depends on carrier.

string

<val n="zipcode">

Postal code

string

<val n="city">

City

string

<val n="country">

Country

string

<val n="contact">

Contact person

string

<val n="phone">

Contact person phone number

string

<val n="email">

Contact person email address

string

<val n="sms">

Contact person mobile phone number

string

<val n="orgno">

Organization number (Sweden only)

string

<val n="vatno">

VAT no

string

<partner parid="...">

Attribute parid corresponds to carrier's ID. See the Help > Code lists > Services menu in nShift Delivery

string

<val n="custno">

Customer number

string

<val n="sourcecode">

Usage depends on carrier, specified by carrier

string

<val n="custno_international">

Customer number for international services

string

<val n="ediaddress">

EDI-address

string

<val n="palletregno">

Pallet reg. number for EUR-pallets

string

<val n="terminal">

Carrier departure terminal

string

<val n="paymentmethod">

Payment method for certain mail services.

string

INVO = Credit without delivery note

INVODN = Credit with delivery note

METERED = Domestic franking

<val n="bookingid">

Booking ID-number

string

<val n="bookingoffice">

Booking office

string

<val n="custnoissuercode">

Customer number issuer

string

<val n="eorino">

EORI number (DHL Express only)

string

Receiver

Declared as <receiver rcvid="..."> under the root element <data>.

Value name

Description

Type

Value

<val n="name">

Name

string

<val n="address1">

Address line 1

string

<val n="address2">

Address line 2

string

<val n="housenumber">

House number. Usage depends on carrier.

string

<val n="addition">

Addition to house number, such as a letter. Usage depends on carrier.

string

<val n="zipcode">

Postal code

string

<val n="city">

City

string

<val n="state">

State/region

string

<val n="country">

Country

string

<val n="contact">

Contact person

string

<val n="phone">

Contact person phone number

string

<val n="email">

Contact person email address

string

<val n="sms">

Contact person mobile phone number

string

<val n="doorcode">

Door code

string

<val n="orgno">

Organization number (Sweden only)

string

<val n="vatno">

VAT no

string

<partner parid="...">

Attribute parid corresponds to carrier's ID. See the Help > Code lists > Services menu in nShift Delivery

string

<val n="custno">

Customer number

string

<val n="palletregno">

Pallet reg. number for EUR-pallets

string

<val n="terminal">

Carrier departure terminal

string

<val n="agentno">

Agent ID.

string

<val n="custnoissuercode">

Customer number issuer

string

<val n="eorino">

EORI number (DHL Express only)

string

Party

Declared as <party ptyid="..."> under the root element <data>.

Value name

Description

Type

Value

<val n="name">

Name

string

<val n="address1">

Address line 1

string

<val n="address2">

Address line 2

string

<val n="zipcode">

Postal code

string

<val n="city">

City

string

<val n="country">

Country

string

<val n="contact">

Contact person

string

<val n="phone">

Contact person phone number

string

<val n="email">

Contact person email address

string

<val n="sms">

Contact person mobile phone number

string

<val n="doorcode">

Door code

string

<val n="orgno">

Organization number (Sweden only)

string

<val n="vatno">

VAT no

string

<partner parid="...">

Attribute parid corresponds to carrier's ID. See the Help > Code lists > Services menu in nShift Delivery

string

<val n="custno">

Customer number

string

<val n="palletregno">

Pallet reg. number for EUR-pallets

string

<val n="terminal">

Carrier departure terminal

string

<val n="agentno">

Agent ID

string

<val n="custnoissuercode">

Customer number issuer

string

Shipment

Declared as <shipment orderno="..."> under the root element <data>.

Value name

Description

Type

Value

<val n="from">

Defines the sender. Refers to the sndid value for sender.

string

<val n="legalfrom">

Defines the legal sender (not printed on shipping documents by default)

string

<val n="to">

Defines the receiver. Refers to rcvid value for receiver.

string

<val n="returnto">

Return address

string

<val n="legalto">

Defines the legal receiver (not printed on shippings documents by default)

string

<val n="agentto">

Agent ID for recipient in shipment, that is, ID of pickup location.

string

<val n="customsfrom">

Exporter

string

<val n="customsto">

Importer

string

<val n="shpid">

Shipment ID. Normally assigned by nShift Delivery

string

<val n="freetext1">

Free text field. Can be used for delivery instructions, for example. Printed on shipping documents. 4 lines available, freetext1-4. Max. 30 characters/line.

string

<val n="eurpallets">

Number of EUR pallets in the shipment. Requires palletregno for sender and receiver.

string

<val n="halfpallets">

Number of half pallets in the shipment (pallet exchange)

string

<val n="quarterpallets">

Number of quarter pallets in the shipment (pallet exchange)

string

<val n="reference">

Shipment reference. Max. 17 characters.

string

<val n="referencebarcode">

Shipment reference as barcode. Max. 17 numeric characters. Availability may vary depending on service.

string

<val n="rcvreference">

Receiver's reference. Max. 17 characters.

string

<val n="carrierspecificreference">

Generic field that can be used for any kind of carrier specific reference.

string

<val n="goodsdescription">

Description of shipment contents.

string

<val n="sisfreetext1">

Free text field. Can be used for delivery instructions, for example. Printed on shipping documents. 5 lines available, sisfreetext1-5. Max. 30 characters/line.

string

<val n"cmrfreetext1">

Free text field. Can be used for delivery instructions, for example. Printed on CMR waybill only. 5 lines available, cmrfreetext1-5. Max. 30 characters/line.

string

<val n="cmrdocuments1">

Fields for additional documents. 2 lines available, cmrdocuments1-2. Max. 30 characters/line.

string

<val n="cmrspecialagreement">

Specifies any special agreement. Max. 30 characters.

string

<val n="waybillcondition">

Defines condition for the waybill. Max. 30 characters.

string

<"val n="bulkid">

ID for PostNord waybills.

string

<val n="termcode">

Delivery terms or freight payer information. See the Help > Code lists Service (ERP-connection XML) or Terms - UPS in nShift Delivery.

string

<val n="termlocation">

Defines the location where takeover for the specified delivery term is done.

string

<val n="printset">

Defines which documents to print. Pipe characters are mandatory.

string

|label| = Label only |sis| = Waybill only |*| = None

<val n="shipdate">

Shipment date, supplied as YYYY-MM-DD. Printed on certain shipping documents. The default value is the current date. Please note that EDI is sent on this date.

string

<val n="deliverydate">

Delivery date, supplied as YYYY-MM-DD.

string

<val n="deliverytimeearliest">

The earliest delivery time, supplied as HH:MM.

string

<val n="deliverytimelatest">

The latest delivery time, supplied as HH:MM

string

<val n="deliveryinstruction">

Delivery instructions

string

<val n="customlabeltext1">

Text on customized label layouts

string

val n="customlabeltext2"

Text on customized label layouts

string

val n="customlabeltext3"

Text on customized label layouts

string

val n="customlabeltext4"

Text on customized label layouts

string

val n="customlabeltext5"

Text on customized label layouts

string

val n="customlabeltext6"

Text on customized label layouts

string

<val n="customsunit">

Customs currency code

string

<val n="flags">

Special address formatting

string

|3plformat| = Prints out sender’s address (legalfrom) instead of pickup address (from) on label/shipping documents.

<val n="pdfinsert">

Specifies PDF filename that is to be used for OneDoc (integrated document) feature.

string

<val n="route">

Defines internal route code for the shipment

string

<val n="unitcode">

Unit code. Only given if instructed by carrier.

string

<val n="payerfreight">

Defines other freight payer. Refers to the ptyid value for freight payer.

string

Service

Declared as <service srvid="..."> under the <shipment> element. For available services, see Help > Code lists > Services in nShift Delivery.

Value name

Description

Type

Value

<val n="returnlabel">

Defines if the shipment is a return shipment or not

boolean

YES, NO, BOTH

<val n="nondelivery">

Defines action when the package is undeliverable

string

RETURN = Return to sender ABANDON = Treat as abandoned in receiver's country

<val n="slac">

Defines Shipper's Load and Count (SLAC) = total shipment pieces (for example, 3 boxes and 3 pallets of 100 pieces each = SLAC of 303).

string

YES, NO

<val n="bookingid">

Defines booking ID/booking number

string

YES, NO

<val n="waybillinvoice">

Defines number of invoices

string

<val n="waybilleurcertificate">

Defines number of EUR-certificates

string

<val n="waybillexportnotification">

Defines number of export notifications

string

<val n="waybillincludedinbulk">

Defines if waybill is included in bulk.

boolean

YES, NO

<val n="sortpos">

Receiving hub

string

Addon

Declared as <service srvid="..."> under the <shipment> element. For available services, see Help > Code lists > Services in nShift Delivery.

Value name

Description

Type

Value

<val n="amount">

Amount. Used with Cash On Delivery addon.

string

<val n="custno">

Customer number for carrier. Used primarily with RPAY (receiver pays) and OPAY (other payer) addons.

string

<val n="reference">

Payment reference. Used with Cash On Delivery addon

string

<val n="referencetype">

Reference type.

string

TXT = Text OCR = OCR number

<val n="misc">

Defines value for misctype

string

<val n="misctype">

Sets notification mode for Notification addon. See Help > Code lists > Service codes - Integration menu in nShift Delivery .

string

<val n="account">

Account number. Used with Cash On Delivery addon.

string

<val n="accounttype">

Account type. Used with Cash On Delivery addon.

string

PGTXT = PlusGiro (Text reference) PGOCR = PlusGiro (OCR reference) BGTXT = BankGiro (Text reference) BGOCR = BankGiro (OCR reference) ACCDKOCR = Account Denmark (OCR reference) ACCDKTXT = Account Denmark (Text reference) ACCSETXT = Account Sweden (Text reference) AVISETXT = Avi account Sweden (Text reference) ACCFI = Account Finland ACCFO = Account Faroe Islands ACCIS = Account Iceland ACCNO = Account Norway (Text reference) ACCNOOCR = Account Norway (OCR reference) ACCPL = Account Poland ACCDE = Account Germany ACCAX = Account Åland Islands Konto = Offshore account

<val n="text1">

Defines value for misctype. See Help > Code lists > Service codes - Integration menu in nShift Delivery .

string

<val n="text2">

Defines value for misctype. See Help > Code lists > Service codes - Integration menu in nShift Delivery .

string

<val n="text3">

Defines value for misctype. See Help > Code lists > Service codes - Integration menu in nShift Delivery .

string

<val n="text4">

Defines value for misctype. See Help > Code lists > Service codes - Integration menu in nShift Delivery .

string

<val n="bank">

Bank ID.

string

<val n="tempmax">

Maximum temperature allowed.

string

<val n="tempmin">

Minimum temperature allowed.

string

Booking

Declared as <booking> under the <service> element. Used when booking of pickup should be done in conjunction with printing.

Value name

Description

Type

Value

<val n="pickupbooking">

Perform booking

boolean

YES, NO

<val n="pickupdate">

Pickup date. Supplied as YYYY-MM-DD.

string

<val n="pickuptimefrom">

Earliest pickup time. Supplied as HH:MM

string

<val n="pickuptimeto">

Latest pickup time. Supplied as HH:MM

string

<val n="pickuptext1">

Pickup instructions

string

<valn ="pickupmisc">

Defines where to send pickup confirmation. Only email can be supplied at this time. Must be supported by carrier.

string

Container

Declared as <container type="..."> under the <shipment> element. See section Container in Shipment for attribute value explanation.

Value name

Description

Type

Value

<val n="copies">

Number of parcels

integer

<val n="prcid1">

Parcel ID

string

<val n="marking">

Goods marking

string

<val n="packagecode">

Package code. See Help > Code lists > Package codes menu in nShift Delivery..

string

<val n="weight">

Weight

float

<val n="volume">

Volume

float

<val n="area">

Load meter. Must be placed in a separate container node as container type="totals" measure="totals".

float

<val n="length">

Length

float

<val n="width">

Width

float

<val n="height">

Height

float

<val n="itemno">

Item number

string

<val n="contents">

Contents

string

<val n="dnguncode">

UN-number for ADR.

string

<val n="dnghzcode">

Label number for ADR (subsidiary risk)

string

<val n="dngpkcode">

Packaging group.

string

I, II, III

<val n="dngadrclass">

ADR-class (main class)

string

<val n="dngdescr">

Official transport name for item regarding ADR (proper shipping name)

string

<val n="dngtechnicaldescr">

Technical description

string

<val n="dngmpcode">

Defines if the contents contaminate the marine environment.

string

1 = Toxic 2 = Non-toxic

<val n="dngnote">

Note for ADR

string

<val n="dngnetweight">

Net weight for ADR goods class I or brutto for Limited Quantities

string

<val n="dngnetvolume">

Net volume for ADR goods

string

<val n="dngtrcode">

Tunnel restriction code

string

<val n="dngpktype">

ADR package type

string

<val n="dngquantity">

Quantity of package type

string

<val n="dnglimitedquantities">

Defines if the parcel row contains limited quantities of dangerous goods

boolean

YES, NO

<val n="pallet">

Sets amount of pallets. Must be placed in a separate container node as container type="totals" measure="totals".

string

<val n="piece">

Sets amount of pieces. Must be placed in a separate container node as container type="totals" measure="totals".

string

Item

Declared as <article> under the <container> element.

Value name

Description

Type

Value

<val n="articleno">

Item number

string

<val n="name">

Item name

string

<val n="count">

Number of items

integer

<val n="enot">

Defines whether the item information should be shown in a pre-notification email message.

boolean

YES, NO

<val n="price">

Price

float

<val n="currency">

Currency code

string

<val n="taxrate">

Tax rate applied to the item.

double

Use the unit percentage (%).

<val n="discountrate">

Discount rate applied to the item.

double

Use the unit percentage (%).

<val n="weight">

Weight

float

<val n="volume">

Volume

float

<val n="contents">

Contents

string

<val n="marking"

Goods marking. Only used by goods services.

string

<val n="packagecode">

Package code. See Help > Code lists > Package codes menu in nShift Delivery..

string

<val n="dnguncode">

UN-number for ADR.

string

<val n="dnghzcode">

Label number for ADR (subsidiary risk)

string

<val n="dngpkcode">

Packaging group.

string

I, II, III

<val n="dngadrclass">

ADR-class (main class)

string

<val n="dngdescr">

Official transport name for item regarding ADR (proper shipping name)

string

<val n="dngtechnicaldescr">

Technical description

string

<val n="dngmpcode">

Defines if the contents contaminate the marine environment.

string

1 = Toxic 2 = Non-toxic

<val n="dngnote">

Note for ADR

string

<val n="dngnetweight">

Net weight for ADR goods class I or brutto for Limited Quantities.

string

<val n="dngtrcode">

Tunnel restriction code

string

<val n="dngpktype">

ADR package type

string

<val n="dngquantity">

Quantity of package type

string

<val n="dnglimitedquantities">

Defines if the parcel row contains limited quantities of dangerous goods

boolean

YES, NO

<val n="dngflashpoint">

Flash point

string

<val n="dngseparation">

Separation

string

Customs data

Declared as <customsdata> under the <article> element.

Value

Description

Type

Value

<val n="statno">

Statistic number/TARIC code/Commodity code

string

<val n="substatno1">

Commodity code, sub. code

string

<val n="units">

Unit/package type

string

<val n="otherquantity">

Other quantity.

double

<val n="customsvalue">

Customs value

float

<val n="contents">

Contents

string

<val n="netweight">

Net weight (kg)

float

<val n="sourcecountry">

Country of origin

string

Options

Options are declared under parent <ufonline> element nested in the <shipment> element.

Email pre-notification

Declared as <option optid="enot"> under the <ufonline> element.

Value name

Description

Type

Value

<val n="from">

Sender of email message

string

<val n="to">

Recipient

string

<val n="cc">

Recipient of message copy

string

<val n="bcc">

Recipient of message blind copy

string

<val n="errorto">

Recipient of error message in case of non-delivery

string

<val n="message">

Text in the email message. Use pipe character (|) for line breaks.

string

<val n="mailtemplate">

Mail template. Used for branded pre-notification email

string

Link to print

Declared as <option optid="lnkprtn"> (normal) or <option optid="lnkprtr"(return) under the <ufonline> element.

Value

Description

Type

Value

<val n="sendemail">

Send email message containing the link

boolean

YES, NO

<val n="from">

Sender of email message

string

<val n="to">

Recipient

string

<val n="cc">

Recipient of message copy

string

<val n="bcc">

Recipient of message blind copy

string

<val n="message">

Text in the email message. Use pipe character (|) for line breaks.

string

Consolidated shipment

Declared as <option optid="consolidate"> under the <ufonline> element.

Customs declaration documents

Declared as <customsdeclaration documents="..."> under the shipment element.

Value name

Description

Type

Value

<val n="invoicetype">

Invoice type. STANDARD is default.

string

PROFORMA = Proforma STANDARD = Commercial invoice

<val n="senderorgno">

Sender's organization number (Sweden only) (2)

string

<val n="receiverorgno">

Receiver's organization number (Sweden only) (8)

string

<val n="senderphone">

Sender's phone number

string

<val n="receiverphone">

Receiver's phone number

string

<val n="sendereorino">

Sender's EORI number (DHL Express only)

string

<val n="receivereorino">

Receiver's EORI number (DHL Express only)

string

<val n="sendercustno">

Sender's customer number (PostNord only)

string

<val n="receivercustno">

Receiver's customer number (PostNord only)

string

<val n="parcelcount">

Parcel count (6)

string

<val n="reference">

Reference number (7)

string

<val n="sourcecountry">

Country of origin (16)

string

<val n="destcountry">

Destination country (17)

string

<val n="shipcodeborder">

Means of transport at the border (25)

string

SEA, RAIL, ROAD, AIR, POST or FIXED = Fixed transport WATER = Water transport on inner waterways OWN = Own propulsion

<val n="shipcodedomestic">

Means of transport (domestic) (26)

string

SEA, RAIL, ROAD, AIR, POST or FIXED = Fixed transport WATER = Water transport on inner waterways OWN = Own propulsion

<val n="finance1">

Financial information. 2 lines available, finance1-2 (28).

string

<val n="declcity">

City (54)

string

<val n="decldate">

Date (54)

string

<val n="edocnormal">

True if normal export procedure, false if commercial item list is attached

boolean

YES, NO

<val n="repr1">

Declarant's/agent's representative. 2 lines available, repr1-2. (14)

string

<val n="reprorgno">

Declarant's / agent's organization number (14)

string

<val n="invoiceno">

Invoice number

string

<val n="freightcharges">

Freight charges

string

<val n="vatcharges">

VAT charges

string

<val n="insurancecharges">

Insurance charges

string

<val n="othercharges">

Other charges

string

<val n="explicenseno">

Export license number

string

<val n="expdecl1">

Export declaration. Default:"I declare that of the best of my knowledge the information on this invoice is"

string

<val n="expdecl2">

Export declaration. Default: "true and correct."

string

<val n="generalnotes1">

General description of the contents. 4 lines available, generalnotes1-4.

string

<val n="supervisor">

Invoice supervisor

string

<val n="jobtitle">

Invoice supervisor's job title

string

<val n="customsunit">

Customs currency unit

string

<val n="impexptype">

Import/export type

string

TEMPORARY = Temporary REEXPORT = Re-export GIFT = Gift DOCUMENTS = Documents SAMPLE = Sample RETURN = Return OTHER = Other, requires the explanation value PERMANENT = Permanent INTERNAL = Internal

<val n="invoicedecl1">

Invoice declaration. Default: "The exporter of the products covered by this document declares that, except"

string

<val n="invoicedecl2">

Invoice declaration. Default: "where otherwise clearly indicated, these products are of EU preferential origin."

string

<val n="implicenseno">

Import license number

string

<val n="certificate">

Certificate

string

<val n="explanation">

Explanation. Only use if impexptype is set to OTHER

string

<val n="comment1">

4 lines available, comment1-4.

string

<val n="termcode">

Delivery terms

string

<val n=”termsofpayment”>

Terms of payment

string

Customs declaration lines

Declared as <line> under the <customsdeclaration element.

Value

Description

Type

Value

<val n="statno">

HS Tariff code (stat no) (33)

string

<val n="substatno1">

Additional codes. 2 lines available, substatno1-2. (33)

string

<val n="procedure">

Procedure (37)

string

<val n="grossweight">

Gross weight (kg)

string

<val n="statvalue">

Stat value

string

<val n="goodsmark1">

Goods marking. 6 fields available, goodsmark1-6. (31)

string

<val n="specinfo1">

Special information. 4 fields available, specinfo1-4. (44)

string

<val n="contents">

Contents/item name

string

<val n="quantity">

Quantity, concerns number of units, for example, 1 box. Default value is 1.

string

<val n="netweight">

Net weight (kg) (38)

string

<val n="customsvalue">

Customs value (46)

string

<val n="sourcecountry">

Country of origin, supplied as ISO country code. (34)

string

<val n="units">

Unit/packaging type. Can vary depending on carrier.

string

GRAM = Gram M2 = Meters squared LITER = Litre PAIR = Pair PIECE = Piece CRATE = Crate

<val n="otherquantity">

Other quantity/unit, for example, 30. The unit is set by statno, for example, piece.

string