Guides

sender, receiver and payer nodes

Parties in the delivery process

There are three parties that are included in ISF for each delivery process, described in
the following nodes (all three nodes are obligatory):

  1. /sender/ - describes from whom the shipment will be dispatched
  2. /receiver/ - describes to whom the package will be delivered
  3. /payer/ - describes who will pay for the packages each with optional attributes:
    1. @id for internal identification (e.g. sender-123, customer-62 or payer-68),
    2. @language for notification purposes.

All of these three nodes have a similar structure, the similarities and differences are described
in this chapter. The following nodes are used:

  1. /external_id/ (optional) - contains a user ID that is used in an external courier system
  2. /address/ (obligatory) - contains address data for the current party including the following nodes:
    1. /name/ - the name of the recipient or the contact person for companies
    2. /company/ - the name of the company
    3. /country/ - the name of the country in the ISO 3166-1 alpha-2 format (e.g. PL, US, DE)
    4. /subdivision/ - the name of the subdivision (region, province, state, etc.) in the ISO 3166-2 format (e.g. PL-ZP, US-DC, DE-BB)
    5. /postcode/ - the postal code
    6. /city/ - the name of the city
    7. /address/ - one node for the name of the street, the house/building number, the floor/department/room number to be divided by the courier/broker if necessary
    8. /telephone/ - the telephone number (only for /sender/ and /payer/, the recipient telephone will be passed in /receiver/contact/)
    9. /type/ - enables the distinction between “private” (houses and flats) and “business” (companies and pickup points) addresses
    10. /notifications/ (optional)

There are three types of notifications included in ISF - text (SMS), e-mail and voice (audio) messages. The language used in the notifications depends on the language setting for the /sender/ and the /receiver/ in the particular nodes. The following nodes are designed to facilitate those notifications:

  1. /text/ - enables text (SMS) messages with the following options:
    1. use the optional /text/@number attribute to specify a telephone number for notifications (other than the obligatory number in /receiver/contact/telephone/)
    2. if the courier enables defining the contents of the text notification, the expected text should be passed directly in the /text/ node
    3. use the optional /text/@type attribute to choose the types of events that result in messages being sent:
    4. @type=”create” - The shipment has been created in the courier system
    5. @type=”ship” (default for /receiver/) - The shipment is on the way (has been picked up by the courier or delivered to his facility)
    6. @type=”courier” - The shipment has been picked up by the delivering driver in the destination city
    7. @type=”delivery” (default for /sender/) - The shipment has been delivered
    8. @type=”exception” - There has been an issue with the package which requires customer's attention
  2. /email/ - enables e-mail notifications with the following options:
    1. use the optional /email@address attribute to specify an e-mail address for notifications (other than the address in /receiver/contact/email/)
    2. if the courier enables defining the contents of the e-mail notification, the expected text should be passed directly in the /email/ node
    3. use the optional /email@type attribute to choose the types of events that result in messages being sent:
    4. @type=”create” - The shipment has been created in the courier system
    5. @type=”ship” (default for /receiver/) - The shipment is on the way (has been picked
      up by the courier or delivered to his facility)
    6. @type=”courier” - The shipment has been picked up by the delivering driver in the
      destination city
    7. @type=”delivery” (default for /sender/) - The shipment has been delivered
    8. @type=”exception” - There has been an issue with the package which requires customer's attention
    9. use the /bounce/ node to define the e-mail address for undeliverable notifications in the @address attribute
    10. /voice/ - enables voice notifications (automated or human) with the optional /voice@number attribute to specify a telephone number for notifications (other than the obligatory number in
    11. /receiver/contact/telephone/)

Additional nodes are available for the particular parties:

  1. /sender/
    1. /return_address/ (optional) - the address for undeliverable packages with the following nodes:
    2. /name/ - the name of the recipient or the contact person for companies
    3. /company/ - the name of the company
    4. /country/ - the name of the country in the ISO 3166-1 alpha-2 format (e.g. PL, US, DE)
    5. /subdivision/ - the name of the subdivision (region, province, state, etc.) in the ISO 3166-2 format (e.g. PL-ZP, US-DC, DE-BB)
    6. /postcode/ - the postal code
    7. /city/ - the name of the city
    8. /address/ - one node for the name of the street, the house/building number, the floor/department/room number to be divided by the courier/broker if necessary
    9. /telephone/ - the telephone number
    10. /type/ - enables the distinction between “private” (houses and flats) and “business” (companies and pickup points) addresses
  2. /receiver/
    1. /contact/ (obligatory) - contains details about the person responsible for receiving the package with the following nodes:
      1. /name/ (optional) - name of the contact person
      2. /telephone/ (obligatory) - telephone number of the recipient, used as the default number for notifications (if not otherwise specified in /receiver/notifications/)
      3. /email/ (optional) - e-mail address
    2. /pickup_point/ (optional) - contains details for pickup points owned by the courier (e.g. own warehouse, service point, paketshop) or owned externally (e.g. a pickup in a shop, or a stationary branch of an online shop) with the following nodes:
      1. /id/ - contains the unique identification number of the location
      2. /country/ - the name of the country in the ISO 3166-1 alpha-2 format (e.g. PL, US, DE)/subdivision/ - the name of the subdivision (region, province, state, etc.) in the ISO 3166-2 format (e.g. PL-ZP, US-DC, DE-BB)
      3. /postcode/ - the postal code
      4. /city/ - the name of the city
      5. /address/ - one node for the name of the street, the house/building number, the floor/department/room number to be divided by the courier/broker if necessary.
  3. /payer/
    1. /address/tax_id/ - enables passing tax identification number (e.g. NIP, Steuer-IdNr.).

Updated 9 months ago

Did this page help you?