IMS Customer Interfaces - Interface documentation
Interface Order Inbound
See Also Send Feedback
Interface Order Inbound > Interface Order Inbound

Glossary Item Box

The interface Order Inbound supports the transmission of orders from the customer to IMS.

 

The interface system contains the following data schemas.

Interface type current release Date of release Description
IMS_CI_Order IMS_Schemas_Ext.PxB_CI_OI.V3130 14.04.2017 XML-schema for order data
IMS_CI_ACK IMS_Schemas.PxB_CI_ACK.V1-2-0-1 01.02.2011 XML-schema for acknowledge data

 

To sign in for this interface see Application for electronic data exchange

To ensure the functionality fo a common interface we strongly recommend a test phase to check all the transmitted data without forward them to the production systems of IMS.

 

Showtechnically spezifications

Specification Description
File name

CI_OI_3-1-3-0_xxxxxxxxxxx.XML

placeholder Content
xxxxxxxxxxx

unique identifier of this interface file, generated by the customer.

The name of the interface file has to be unique. Even if you are retransmitting a file, because the first one was declined because of errors, you have to use a new file name.

Encoding "utf-8"
Content
A single interface file can only contain one single order.

 

ShowCommunication

There are multiple ways of communicaton available.

Type of communication Description
FTP

You'll have an account on the FTP server of IMS. There are two directories present:

Directory Description
inbound

This directory represents the inbound directory of IMS to put your data files. In the present release, this are only the order inbound files.

To prevent the receiving system to process the files before the sending process is done, you have to set the final filename after the sending process is done.

We suggest using the file extension ".tmp" during the sending process. After the file is transmitted, rename the file to ".xml". 
outbound

This directory provides you with all files send from IMS to the customer. In the present release, this contains the acknowledgement files.

Mail

The data files have to be sent as attachments within a mail.

 

Field Description

Inbound

Please send the mail as plain-text.
Receiver

the mail receiver is the following mail-address:

"interfaces.at@imscargo.com"

Do not send any other mails to this mail-address besides mails with data files. Mails addressed to this mail-address are processed automatically and not recognized by any employee of IMS.
Subject

The subject of the mail has to start with the text "IMS Order-Inbound". You can extend the subject with any other text.
Object

The text in the object of the mail is ignored by the interface system. Please do not send any information for IMS in the object of the mail.
Attachment

The attached interface file has to match the rules for naming (see technical specifications above)
Receipts

The IMS mail server will not send any delivery or read receipts for received mails. The inbound of the interface file will be announced by sending a Acknowldege file.

Outbound
Sender

All interface mails from IMS will be send with the sender:

"CustomerInterfaceRobot@imscargo.com"

Do not send any mail to this email-address. This mail-address is only used as the sender for automated mails created by the IMS interface system.
Subject

The text in this field for sending Acknowledge-messages is:

"Customer-Interfaces Order-Inbound ACK für File ID nnnnnn"

"nnnnnnn" = GUID (this is the Message-Ident of the data transmission (inbound), on which this Acknowledge is based on.
Object The text is only for informational purpose, and there is no need to process any of this information.
Attachment

The attached interface file has to match the rules for naming (see technical specifications above)
Receipts The IMS server will not ask for any delivery or reads receipts.

Content
Within one single mail, there is only one attached data file allowed.

 

ShowWorkflow diagram

Ablaufdiagramm

 

ShowLegende

Sendungsnummer Description
1

Sending of an order to IMS

Interface type Direction
IMS_CI_Order Outbound

2

Sending of the "technical acknowledge" from IMS to the customer

Interface type Direction
IMS_CI_ACK Outbound

With the sending of a technical acknowledge IMS is conforming the inbound of your data transmission. (In this case, the Order Inbounds). 

The technical ACK is only confirming the reception of the data file, not if the data is valid and successfully processed!

If an error is occurring during the reception process, there will be no technical acknowledge send!

Because there are so many steps during the transmission process (FTP client, FTP server, copying/renaming of the file, interface system offline, ...), it is not possible to create a negative technical acknowledge message. Please take care, that your system is informing you about data sendings without a technical acknowledge within approx. 30 minutes. If such an error occurs, we have to investigate about the error manually.
3

Information about technical errors within the data file (invalid XML structure or invalid values in single nodes/fields)

This information is send as a data acknowledge with information about the errors occurred during the test of the XML structure.

interface type Direction
IMS_CI_ACK Outbound

If there is an error detected during the testing of the XML document, the processing of the data will stop because it is not possible to evaluate the logical correctness of the data.

It is possible, that after you adjust and resend the data file, there will be an error detected during the logical check of the transmitted data.

see IMS_CI_ACK
4

Informations about logical errors within the transmitted data (Dangerous goods without dangerous goods declarations, ...)

This informations is sent as a data acknowledge with informations about the errors occurred during the processing of the data.

Interface type Direction
IMS_CI_ACK Outbound

see IMS_CI_ACK
5

Information about errors occurred during the processing of the order inbounds.

This information is sent as a data acknowledge with informations about the errors occurred during the processing of the data.

Interface type Direction
IMS_CI_ACK Outbound

see IMS_CI_ACK
6

IMS is sending a data acknowledge to the customer to inform about the successful processing of the order inbounds. Your order will be forwarded to our sales employees for the final check.

Interface type Direction
IMS_CI_ACK Outbound

This data acknowledge contains all the reference numbers your order in the IMS Systems.

see IMS_CI_ACK
7

The customer doesn't need to store all the references send within the final data acknowledge. If you receive any further information about your order, your order reference will always be part of this information.

 

See Also

©IMS CARGO Austria 2017. All rights reserved.