Support Portal

Welcome
Login

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

FieldMandatoryType
ExampleDescription
carrier_nameYesStringmondialrelayThe carrier which should be selected.
countryYes
String
FRSpecifies country in search criteria.

city

ConditionalString

Paris

Specifies city in search criteria.

zip


Conditional
String

75017

Specifies postal code in search criteria.

street

Conditional
String
Av. des TernesSpecifies street in search criteria.
house_noConditional
String
58Specifies 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_resultsNo
Number
10The 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

FieldType
ExampleDescription
carrier_nameStringmondialrelayThe selected carrier.
location_typeStringPOST_OFFICELocation type.
location_idString004694General location identifier which is mostly used.
location_codeString002318317571238Internal location identifier which is used for specific cases.
address.nameString
Paris TelecomThe name of location.
address.alternative_nameString
4694 TernesThe alternative name, description or localization details.
address.provider_address_lineString
58 Av. des TernesThe original address line or combined street with house number. In some cases this field may supply street and house number fields after conversion.
address.countryString
FRThe 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 TernesThe street of address location.
address.house_noString
58Specifies 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.
distanceNumber
0The distance between requested location and existing location.
additional_attributesJson

{

    "name": "key",

    "value": "value"

}

The additional attributes which are provided as custom key-value pairs.




Did you find it helpful? Yes No