Use local collect shipment service

In the SAPIENT system, the integration of the PUDO API allows Royal Mail customers to efficiently access collection point locations for their shipments. This API is a vital component of the local collect enhancement, offering a flexible solution during the checkout process.

How it works

1. Integration Activation: The PUDO integration must be enabled within the Sapient system for customers to leverage this feature.

2. Ad-Hoc Calling: During the checkout process, customers can call the PUDO API to retrieve a list of nearby collection points based on their delivery address.
3. Result Delivery: The API responds with a real-time list of PUDO locations for selection.

The following new query parameters have been added to the Get PUDO Locations API request.

The following snippet represents an example JSON response schema of the Get PUDO Location endpoint.

{
  "Locations": [
    {
      "CarrierCode": "RM",
      "LocationAlias": "J S Pound Plus",
      "LocationId": "2373391",
      "Address": {
        "Line1": "10 Grasmere Parade Wexham Road",
        "Line2": "",
        "Line3": "",
        "Town": "Slough",
        "Postcode": "SL2 5HZ",
        "Geolocation": {
          "Longitude": -0.5787,
          "Latitude": 51.5183
        },
        "OpeningHours": {
          "Monday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Tuesday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Wednesday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Thursday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Friday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Saturday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          },
          "Sunday": {
            "OpeningTime": "10:00:00",
            "ClosingTime": "21:00:00"
          }
        }
      },
      "enhancedLocationDetails": {
        "LocationType": "PSH",
        "Supplier": "Collect+",
        "SupplierLocationType": "Collect+",
        "LabelId": "31262463",
        "DistanceFromPostcode": "3.2",
		"DistanceUnit": "miles",
        "LocationAvailableFeatures": {
          "ServiceCode": "TPN|TPS|TPM|TPL|ITL|ITM|ITN|ITS|TRL|TRM|TRN|TRS|ITC|ITD|ITE|ITF",
          "AcceptSignature": "True",
          "AcceptNonSignature": "True",
          "LocationServices": "pickup|dropoff|printinstore",
          "Facilities": "carparking"
        },
        "LocationRestrictions": {
          "MaxHeight": "",
          "MaxWidth": "",
          "MaxLength": "",
          "MaxWeight": "",
          "MaxSize": ""
        }
      }
    }
  ],
  "TotalCount": 1
}

The PUDO SFTP (Secure File Transfer Protocol) integration involves establishing a secure connection that enables customers to securely connect to a location to pick up a CSV file containing all the Royal Mail PUDO locations.

How it works

You can use the SFTP solution, if you want to download the PUDO data into your own system to check the PUDO locations that are close by to a given address by yourself.

🚧

Important

If you want to set up the PUDO integration, make sure to meet the following prerequisites:

• Enable PUDO integration via the Royal Mail Integration Activation screen.

  

• Create a location for us to connect, and then raise a request to our onboarding team for PUDO data via SFTP by providing your RSA Public Key through a secure gateway. Based on the details provided, our team will respond back with your connection details.

The PUDO SFTP solution provides you with all locations in a single file that you can store as a library.

💡

Tip

The file is generated on a daily basis. To learn more about the file structure and its data, refer to the following example file:

• RMPUDO20250619

This file is available for download on a daily basis via SFTP. You must first connect to the location, download the file, and then close the connection. You cannot delete or move the file, you can only download it.

In SAPIENT, there are two distinct ways to create a Royal Mail shipment aimed at delivery to a PUDO point—one method involves using the direct address of the chosen location, while the other relies on utilising the pudoId returned from the PUDO lookup, offering flexibility in how shipments can be generated.

To make the LocalCollect shipment request, it is necessary to provide the following information:

1. The request must include “c/o” with the location name.
2. The ServiceEnhancements code—LocalCollect must be used.
3. The Email or SMS notification service enhancement must be used by providing the destination's ContactPhone or ContactEmail information, so the end consumer can be notified when their item is ready to be collected from the post office.

Keeping intact the existing functionality, for a more enhanced user experience, new pudoId field is included in Address object of the Royal Mail Create Shipment request to recognise the specific Royal Mail location by its unique ID. When the pudoId field is utilised, the label and pre-advice will be generated with the updated information.

🚧

Important

Before providing thepudoId, make sure of the following:

• For Royal Mail shipments,pudoId is only supported with the destination address (that is, an outbound shipment for a delivery to a PUDO location) as the Royal Mail's Local Collect label requirements only relate to this address. Please be advised that pudoId is not used for drop-off to a Local Collect store or Lockers as Royal Mail does not use the Unique ID for shipment drop-offs.
• If thepudoId is provided for any other address other than the destination address, an error will be returned.
• If thepudoId is provided for a carrier that does not use PUDO, an error will be returned.
• If the destination company name includes “c/o” and thePudoId is not populated, the existing Local Collect functionality will continue to apply.