Introduction

 The Seven Senders PUDO locator provides a list of PUDO locations and allows you to search for the closest of them based on your location details and specified carrier(s). The information about PUDO locations can be used in your checkout to enable your customers to select their preferred PUDO location.

Changes (related to version 1)

• Added the possibility to limit the maximum distance in meters.
• Added information about list of temporary closing periods.
• Added information about the validity period.
• Added information about carrier-specific supported services.
• Added the "Bulk Feature" which allows to get all PUDO locations for selected carrier and country.
• Changed field name from "provider_address_line" to "address_line".
• Improved address line conversion for both directions.
• Limited PUDO locations up to 50 (only if searching from our database).

Authorization

The credentials for the API consist of an access key, a String provided by Seven Senders. Before starting using the API, you need to request for JWT token by executing the POST /token operation with your access key. Received JWT token should be used inside the Authorization header with the given format: Bearer YOUR_TOKEN for every further request. The JWT token is valid for 60 min.

Use Cases

 To find out more about the API of our PUDO Locator, please go here. 

• 1. GET locations by coordinates:

  It allows you to find the nearest PUDO locations based on your geolocation coordinates.
  In this case, you would have to provide the carrier_names[], country, latitude and longitude parameters.

  ?carrier_names[]=mondialrelay&country=FR&latitude=48.87934&longitude=2.47934
          

• 2. GET locations by address:

  It allows you to find the nearest PUDO locations based on a given address.
  In this case, you would have to provide the carrier_names[], country and zip parameters.
  Some carriers may require also the city or street, to make the result more accurate.

  ?carrier_names[]=mondialrelay&country=FR&city=Paris&zip=75017&street=Av. des Ternes&house_no=58
          

• 3. GET all locations:

  It allows you to get all PUDO locations for the selected carrier and country (not all carriers support this feature).
  In this case, you would have to provide the carrier_name and country parameters.

  ?carrier_name=mondialrelay&country=FR

Example response of PUDO location:

[
    {
        "carrier_name": "mondialrelay",
        "location_type": "SHOP",
        "location_id": "004694",
        "location_code": "002318317571238",
        "address": {
            "name": "Paris Telecom",
            "alternative_name": "4694 Ternes",
            "address_line": "58 Av. des Ternes",
            "street": "Av. des Ternes",
            "house_no": "58",
            "zip": "75017",
            "city": "Paris",
            "country": "FR"
        },
        "valid_from": "2020-01-01",
        "valid_to": "2026-01-10",
        "closing_periods": [
            {
                "from": "2022-08-01",
                "to": "2022-08-10",
                "reason": "holidays"
            }
        ],
        "opening_hours": {
            "monday": [
                {
                    "from": {
                        "hours": 8,
                        "minutes": 30
                    },
                    "to": {
                        "hours": 22,
                        "minutes": 30
                    }
                }
            ],
            "tuesday": [],
            "wednesday": [],
            "thursday": [],
            "friday": [],
            "saturday": [],
            "sunday": []
        },
        "coordinates": {
            "latitude": 48.87934,
            "longitude": 2.47934
        },
        "parcel_sizes": [
            "L",
            "XL"
        ],
        "distance": 0,
        "supported_services": [
            "cardboard sale",
            "case settlement"
        ],
        "additional_attributes": [
            {
                "name": "lean_locker",
                "value": "true"
            }
        ]
    },
]

Request Parameters (Example carrier Mondial Relay)

Response Model