Omniva Developer site (1.0.0)

This document describes the structure and rules about parcel delivery data exchange format (JSON).

The topics covered are:

• Sender/receiver information of the deliveries – requirements for the contact data and the destination;
• Address card and barcodes – the JSON SOAP channel returns proper barcode and address cards;
• Status and events data of deliveries.

The primary contact person for discussing the subjects treated in this document is the Omniva Account manager,
who, if necessary, will involve IT application and/or project management experts in the discussion.

Customer's system will perform HTTP/SOAP request to web service.

JSON data files are created with a universal structure. Requirements about the attributes are described in this document as well.
Example calls are given on Omniva homepage here: Omniva API Examples.

Customer can choose between two shipment registration types:

• Business to customer (B2C): This is used for fully automatic data exchange. No manual work or confirming is needed or possible in the
  business customer e-service. Parcel data, statuses, and parcel labels can be requested via web service.
  Currently, no manifest printing is possible - it should be generated by the Customer's system.

• Customer to customer (C2C): The structure is the same as BusinessToClientMsgRequest. The only difference is that the Customer will
  never be subject to billing. The transportation fee is always paid by the receiver. This is required to be used with parcel label printing.
  The label (PDF) can be sent via email or into the Customer's system for download.
  If the parcel is returned for some reason, the same data will be used, and the transportation fee will be collected from the Sender.

The web service works through SSL using HTTP protocols. The means of authentication is HTTP BASIC AUTHENTICATION.
Username and password with the web service URL will be provided by your Account Manager.

To identify platforms that offer integration solutions for other customers, a header attribute is used:

• Header: X-Integration-Agent-Id
• Value: Developer_XXXXXX_YYYYYY where Developer is a fixed value, XXXXXX is provided by Omniva, and YYYYYY can be used
  by the developer to distinguish different versions of their solution.

The header attribute should be used in all requests.