Enable your customers to select their preferred PUDO location

Introduction

The Seven Senders PUDO locator provides a list of PUDO locations nearest to a given location and specified carrier(s). The provided information can then be used in your checkout to enable your customers to select their preferred PUDO location.

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 until the next token needs to be retrieved.

Use Cases

To find out more about the API of Seven Senders PUDO locator, please go here.

1. Search by coordinates:

In this case, you would have to provide the latitude, longitude and country code.

{
  "carrier_name": "mondialrelay",
  "country": "FR",
  "coordinates": {
    "latitude": 48.87934,
    "longitude": 2.47934
  }
}

2. Search by address:
In this case, you would have to provide the zip, country code (Some carriers may require also the street, to make the result more accurate).
```
{
  "carrier_name": "mondialrelay",
  "country": "FR",
  "city": "Paris",
  "zip": "75017",
  "street": "Av. des Ternes",
  "house_no": "58"
}
```

An example response of PUDO location:

[
  {
    "carrier_name": "mondialrelay",
    "location_type": "POST_OFFICE",
    "location_id": "004694",
    "location_code": "002318317571238",
    "address": {
      "name": "Paris Telecom",
      "alternative_name": "4694 Ternes",
      "country": "FR",
      "city": "Paris",
      "zip": "75017",
      "provider_address_line": "58 Av. des Ternes",
      "street": "Av. des Ternes",
      "house_no": "58"
    },
    "opening_hours": {
      "monday": [
        {
          "from": {
            "hours": 8,
            "minutes": 30
          },
          "to": {
            "hours": 8,
            "minutes": 30
          }
        }
      ],
      "tuesday": [],
      "wednesday": [],
      "thursday": [],
      "friday": [],
      "saturday": [],
      "sunday": []
    },
    "coordinates": {
      "latitude": 48.87934,
      "longitude": 2.47934
    },
    "parcel_sizes": [
      "L","XS"
    ],
    "distance": 0,
    "additional_attributes": null
  }
]

Data model

Request

Field	Mandatory	Type	Example	Description
carrier_name	Yes	String	mondialrelay	The carrier which should be selected.
country	Yes	String	FR	Specifies country in search criteria.
city	Conditional	String	Paris	Specifies city in search criteria.
zip	Conditional	String	75017	Specifies postal code in search criteria.
street	Conditional	String	Av. des Ternes	Specifies street in search criteria.
house_no	Conditional	String	58	Specifies house number in search criteria. This parameter is combined with street.
coordinates	Conditional	Json	{ "latitude": 48.87934, "longitude": 2.47934 }	Specifies the exact search location.
max_number_of_results	No	Number	10	The maximum number of locations to return.
parcel_sizes	No	Array	[ "L", "XL"]	The supported parcel sizes. Some carriers have specific locations for XL shipments.

Response

Field	Type	Example	Description
carrier_name	String	mondialrelay	The selected carrier.
location_type	String	POST_OFFICE	Location type.
location_id	String	004694	General location identifier which is mostly used.
location_code	String	002318317571238	Internal location identifier which is used for specific cases.
address.name	String	Paris Telecom	The name of location.
address.alternative_name	String	4694 Ternes	The alternative name, description or localization details.
address.provider_address_line	String	58 Av. des Ternes	The original address line or combined street with house number. In some cases this field may supply street and house number fields after conversion.
address.country	String	FR	The country of address location.
address.city	String	Paris	The city of address location.
address.zip	String	75017	The postal code of address location.
address.street	String	Av. des Ternes	The street of address location.
address.house_no	String	58	Specifies house number in search criteria. This parameter is combined with street.
opening_hours.monday opening_hours.tuesday opening_hours.wednesday opening_hours.thursday opening_hours.friday opening_hours.saturday opening_hours.sunday	Json	{ "from": { "hours": 8, "minutes": 30 } "to": { "hours": 22, "minutes": 30 } }	Specifies opening hours for each day of week.
coordinates	Json	{ "latitude": 48.87934, "longitude": 2.47934 }	Specifies the exact location place.
parcel_sizes	Array	[ "L", "XL"]	The supported parcel sizes. Some carriers have specific locations for XL shipments.
distance	Number	0	The distance between requested location and existing location.
additional_attributes	Json	{ "name": "key", "value": "value" }	The additional attributes which are provided as custom key-value pairs.

Did you find it helpful? Yes No