pickup points

The ISF format handles external pickup points as a basis for e-commerce solutions responsible for:

downloading and updating information about locations
storing and displaying to customers up-to-date delivery destinations
passing chosen locations to shipments in the ISF format

The information about pickup points is to be prepared by the courier or broker within the pickuppoints.xml, with the main node /locations/ and multiple instances of /pickup-point/ node.

NOTE: The XML file, prepared according to the guidelines, can only be used in the store panel. Using the XML file (import or export of pickup points) is possible in the Administration->Warehouse and Logistics->Courier setup in the 'Pickup in collection point' service, [collection points] option. The following nodes are available to describe each pickup-point within the /pickup-point/ node:

/id/ (obligatory) - contains the unique identification number of the location. This identifier is passed in the dispatch order in the node /receiver/pickup_point/id
/name/ (obligatory) – the name of the pickup-point. Possible to set different name for the various languages. See example in the request example code below.
/country/ (obligatory) - 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)
/postcode/ (obligatory) - the postal code
/city/ (obligatory) - the name of the city
/address/ (obligatory) - one node for the name of the street, the house/building number, the floor/department/room number
/latitude/ - (obligatory) the latitude in decimal degrees (e.g. 53.4175191)
/longitude/ - (obligatory) the longitude in decimal degrees (e.g. 14.5324166)
/status/ - current status of the pickup point, with the following possible values (If no status is sent, the status is set to out_of_service):
1. available – the pickup point is operating and available within the operating hours
2. out_of_service – the pickup point is temporarily unavailable and will be available in thefuture
3. removed – the pickup point is permanently unavailable
4. planned – the new pickup point is unavailable and will be made available in the future
5. /operating_hours/weekday/ - when the pickup point is available. Contains following attributes:
  1. @day - available values: monday, tuesday, wensday, thursday, friday, saturday, sunday
  2. @mode - available values: closed, open_in, 24h
  3. @opening – opening hour in ISO-8601standard e.g. 08:00 (only if @mode=”open_in” has been sent) Not sending working hours of a pickup point sets the status to closed.
  4. @closing - closing hour in ISO-8601standard e.g. 18:00 (only if @mode=”open_in” has been sent) Not sending working hours of a pickup point sets the status to closed.
/description/ - how to find the pickup point. Possible to set different description for the various languages. See example in the request example code below.
/payment_forms/ - list of payment forms that are available for the pickup point in COD (cash on delivery) scenario (not sending information about accepted forms of payment for COD will result in the inability to select a particular point for COD orders), with the possible nodes:
1. /cash/ - cash payment
2. /card/ - card payment
3. /pay_by_link/ - pay-by-link payment
4. /instalments/ - payment in instalments

Request example code

<?xml version="1.0" encoding="UTF-8"?>
<locations author="IAI S.A." file_format="ISF" generated="2017-09-27T16:20:43+0200" version="1.2">
  <pickup_point>
    <id>pp_59c3b289d9208</id>
    <status>available</status>
    <payment_forms>
      <card>yes</card>
    </payment_forms>
    <address>Dubois 9</address>
    <postcode>71-670</postcode>
    <city>Szczecin</city>
    <country>PL</country>
    <subdivision />
    <longitude>14.578447</longitude>
    <latitude>53.466194</latitude>
    <opickup_hours>
      <weekday closed="14:00" day="monday" mode="open_in" opening="08:30" />
      <weekday closed="18:00" day="tuesday" mode="open_in" opening="09:00" />
      <weekday closed="18:00" day="wednesday" mode="open_in" opening="11:00" />
      <weekday closed="18:00" day="thursday" mode="open_in" opening="09:00" />
      <weekday day="friday" mode="closed" />
      <weekday day="saturday" mode="24h" />
      <weekday day="sunday" mode="closed" />
    </operating_hours>
    <name>
      <item language="eng">Newsstand</item>
      <item language="pol">Kiosk</item>
    </name>
    <description>
      <item language="eng">Next to the shopping mall</item>
      <item language="pol">Obok centrum handlowego</item>
    </description>
  </pickup_point>
</locations>