Structure
Structure of the /event/ node
The /event/ is the main part of the /set/ of events included in each ISF file. It describes
an e- commerce event, which in ISF version 1.2 is an order or a return.
Each event contains the @id attribute (number which is unique for the author of the file), and
the @type attribute (event type “order” or “return”) and e.g.: <event id="7777" type="order">
or <event id="7220" type="return">
/Event/ node may occur many times.
- /shipment/
It is an obligatory node to describe a particular shipment, containing one or more
packages. It includes tracking details (number and URL), the label or labels, chosen courier
services, pickup details and costs. - /sender/
It is an obligatory node to describe the sender of the shipment. It includes address data
(where the package is sent from and where it should be returned if delivery is impossible),
notification preferences and optionally an ID for external courier systems. - /receiver/
It is an obligatory node to describe the receiver of the shipment. It includes address data
(where the package should be delivered), details about the contact person, notification
preferences and optionally an id for external courier systems. - /payer/
It is an obligatory node to describe the party due to pay for the shipment. It includes
address data with tax ID and optionally an id for external courier systems. - /return_shipment/
A node about shipments sent back from the receiver to the sender. It can be used in two
scenarios:- An order event generates a shipment with the possibility to create a return label at the
same time (if the customer decides to return the package in the future). The node
/return_shipment/ is optional in this scenario. - A return event generates a shipment when the customer has decided to return their
order and wants to get the return label. The node /return_shipment/ is obligatory in this
scenario.
- An order event generates a shipment with the possibility to create a return label at the
- /ap:additionalParams/
The node in which nodes defined by the developer are placed - filled with data from the
relevant variables. This node is generated automatically based on the structure contained
in the /manifest / additional_parameters node in the manifest.xml file. - /CustomsDeclaration/
An optional node that contains all data for customs declaration – filled with data about
products in package including invoice and who is paing taxes and customs. - /errors/
An optional node that returns errors encountered while interpreting the original ISF file with
their types (priorities), codes, descriptions and positions (nodes) in the structure.
For more details go to the Structure of the /errors/ node chapter.
Updated 9 months ago
Did this page help you?