errors
Structure of the /errors/ node
It is possible to return the error in several places. As the main node for returning general errors
such as an incorrect structure, service unavailability, etc. the /error/ node placed over the
/event/ node is used. To return detailed errors, the /event/@errors/ node is used.
The ISF format distinguishes between two types of errors that are handled in the delivery
process:
- critical - errors that result in a shipment not being delivered or causing substantial losses to
the online shop. They include for example following cases: - A service is not available, e.g. COD for international shipments
- An incorrect address or an address out of the courier's range Such errors are to be
handled within the shop. - noncritical - errors that make the delivery more difficult, but possible. They include for
example: - receiving an inquiry about a courier's service that is available with lower parameters
- delivering a return shipment label in a different way than expected by the customer (e.g.
by e-mail and not as a link)
Such errors are to be handled by the courier/broker according to settings defined by the customer
who signs the contract with the courier/broker.
For example, a broker does not offer a delivery type expected by the customer, but
offers a different one with a longer delivery time. It may be: - a different service of the same courier or
- a service of a different courier
In such a situation the courier/broker should ask the customer whether he wants to get a
cheaper delivery with a different service or receive an error that a delivery is not possible.
The errors are described in separate /error/ nodes with the following subnodes each: - /priority/ - severity of the error, either “critical” (known as errors) or “noncritical” (known
as warnings) - /code/ - alphanumeric code to distinguish the error, e.g. E001. A list of possible errors is
given in the Attachment section at the end of this specification. - /short_description/ - a brief summary of the error, e.g. “COD unavailable for
international shipments”/description/ - detailed information about the error and its
consequences, e.g. “The service COD is unavailable for shipments outside Europe.
Because of safety regulations it is not possible to accept shipments with COD.” - /node/ - XPath to the node where the error occurs, e.g. “/event/shipment/pickup/cod/”
Example code for one error and one warning
<errors>
<error>
<priority>critical</priority>
<code>E001</code>
<short_description>COD unavailable for international shipments</short_description>
<description>The service COD is unavailable for shipments outside Europe. Because of safety regulations it is not
possible to accept shipments with COD.</description>
<node>/event/shipment/pickup/cod/</node>
</error>
<error>
<priority>noncritical</priority>
<code>W001</code>
<short_description>Type of shipment not available</short_description>
<description>The chosen shipment type is not available with this courier. Another type has been chosen in exchange,
which means lower costs but slower delivery.</description>
<node>/event/shipment/service/</node>
</error>
</errors>Updated 9 months ago
Did this page help you?