INintersoftsapient
PUDO Locations

Get PUDO Locations

Changed on

Retrieves a list of Pick-Up and Drop-Off (PUDO) locations associated with a specified carrier that are within a set radius of the postcode provided in the request. That radius is set to 10 Miles / 16.09 Kilometres. With this endpoint, you can find convenient locations for dropping off or picking up shipments, enhancing logistical efficiency and user experience. <br /> <br />Before calling this endpoint, bear in mind the following: <br /> <br />• You must call this endpoint before the Create Shipment endpoint so that the desired PUDO location is selected in the Create Shipment request. <br /> <br />• This endpoint is currently supported by Royal Mail, InPost, InPost Global and DPD. <br /> <br />• For InPost Global (INPOSTGLB) and DPD (DPD), the query parameter shippingAccountId is required (shipping account id or alias) so Sapient can authenticate to the carrier's location API using that account's credentials.

get/v4/pudolocations/{carrierCode}/{countryCode}/{postcode}

Request

  • Base URL
    https://api.intersoftsapient.net
  • URL
    https://api.intersoftsapient.net/v4/pudolocations/{carrierCode}/{countryCode}/{postcode}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.intersoftsapient.net/connect/token

Path parameters

carrierCodestring required

A unique identifier for the shipping carrier for which the PUDO locations are being requested. This code helps specify the provider and ensures that the returned locations are relevant to the selected carrier's service.

countryCodestring required

An abbreviation representing the country in which you are seeking PUDO locations, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.

postcodestring required

The postal or ZIP code corresponding to the area where you want to find PUDO locations. This helps in retrieving the available PUDO locations by narrowing down the search to relevant locations nearby.

Query parameters

maximumResultsinteger

An integer specifying the maximum number of PUDO locations returned in the response. With it, you can control the volume of data returned, optimising performance and usability. <br /> <br />Note: If this value is not specified, then by default, a maximum of 10 PUDO locations will be returned in a single request.

locationServicesstring

This parameter specifies the services available at each PUDO location. It accepts the following values based on the options provided by the location: <br /> <ul><li>Pickup: Indicates that customers can collect their parcels from the location.</li><li>Dropoff: Indicates that the customers can drop off parcels for shipment at the location.</li><li>Printinstore: Indicates that the location offers printing services for shipping labels, allowing customers to print their labels directly at the store.</li></ul> <br />Note: If a service is selected, then the locations offering only the requested service will be returned in the response.

enhancedLocationDetailsboolean

This boolean parameter specifies whether the response includes additional detail about each PUDO location in the form of enhancedLocationDetails object. <br /> <ul><li>If set to true, the response will include enhancedLocationDetails object for each PUDO location. This object provides more comprehensive information, such as facilities available at the location, for example, disabled access, parking, and so on, distance from postcode, and any additional attributes relevant to the location that might assist customers in making informed decisions.</li><li>If set to false, the response will be limited to the basic details of the PUDO locations without the enhanced attributes.</li></ul> <br />Note: By default, this field is set to false.

shippingAccountIdstring

Shipping account id or alias. Required for InPost Global (INPOSTGLB) and DPD (DPD). Ignored for Royal Mail and legacy InPost.

Response

Success

TotalCountinteger

An integer representing the total number of PUDO locations that match the specified query criteria. This provides users with an overview of how many PUDO locations are available on the system, enabling better understanding of the dataset.

Example response

{
  "Locations": [
    {
      "CarrierCode": "RM",
      "LocationAlias": "Post office limited",
      "Address": {
        "Line1": "114-120 Camden High Street",
        "Line2": "Camden Town",
        "Town": "London",
        "Postcode": "TW18 4QR",
        "Geolocation": {
          "Longitude": -0.51174,
          "Latitude": 51.43341
        },
        "OpeningHours": {
          "Monday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Tuesday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Wednesday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Thursday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Friday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Saturday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          },
          "Sunday": {
            "OpeningTime": "09:00:00",
            "ClosingTime": "17:30:00"
          }
        }
      },
      "EnhancedLocationDetails": {
        "LocationType": "POL",
        "Supplier": "Collect+",
        "SupplierLocationType": "Locker",
        "DistanceFromPostcode": 1.4,
        "DistanceUnit": "miles",
        "LocationAvailableFeatures": {
          "ServiceCode": "TPN",
          "LocationServices": "pickup|dropoff|printinstore",
          "Facilities": "carparking|disabledaccess"
        },
        "LocationRestrictions": {
          "MaxSize": "Medium"
        }
      }
    }
  ],
  "TotalCount": 10
}

Changes