Set up PUDO data via SFTP
The Pick Up and Drop Off (PUDO) service facilitates customers to collect or drop off their shipments at designated locations instead of waiting for home delivery. These locations can include retail stores, parcel lockers, or shipping facilities, offering greater convenience and flexibility for customers. PUDO services are particularly beneficial for those who may not always be available for direct delivery, helping to reduce missed delivery attempts and enhance overall customer satisfaction.
The PUDO SFTP (Secure File Transfer Protocol) integration involves establishing a secure connection that enables data exchange between SAPIENT and Royal Mail PUDO service. This integration facilitates the exchange of crucial information, such as drop-off locations, opening and closing times, and shipment tracking details in a secure manner.
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. 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. The file is generated on a daily basis— the structure and its contents are explained in the following sections.
File Naming
All tracking data files will use the following naming conventions.
The elements in the filename are defined as follows:
| Element | Details |
|---|---|
| RM | Royal Mail |
| LC | Local Collect |
| YYY | Year date of file creation |
| MM | Month date of file creation |
| DD | Day date of file creation |
For example, a file generated on 09th September 2019 at 5.32pm would be "RMLC20190909.CSV".
File Structure Overview
Each file consists of a full list of available locations each day. Everyday, these files replace the previous days files.
File Format
The file is saved in the CSV format with comma delimiters.
The following table describes the records and fields that are present in the data file for each PUDO location.
Header Record
| # | Name | Type | Max Length | Comments |
|---|---|---|---|---|
| 1 | Record Type | C | 1 | This will always be H |
| 2 | Date | D | 8 | Represents the date when the file was created in the formatddmmyyyy. |
| 3 | PO Records | D | 6 | Represents the number of Post Office records contained in the file. |
| 4 | CSP Records | D | 6 | Represents the number of CSP Records contained in the file. |
Detailed Record
| # | Name | Type | Max Length | Comments |
|---|---|---|---|---|
| 1 | Record Type | C | 1 | This will always be D |
| 2 | Office Type | C | 3 | Represents the values of either CSP (for RM Customer Service Points) or POL(for Post Offices). |
| 3 | Office number/refence | D | 7 | Represents the unique identifier for the office. |
| 4 | Office Name | C | 50 | Represents the name of the office. |
| 5 | Address Line 1 | C | 50 | Represents the first line of address. |
| 6 | Address Line 2 (if relevant) | C | 50 | Represents the second line of address, if applicable. |
| 7 | Address Line 3 (if relevant) | C | 50 | Represents the third line of address, if applicable. |
| 8 | Address Line 4 (if relevant) | C | 50 | Represents the fourth line of address, if applicable. |
| 9 | Address Line 5 (if relevant) | C | 50 | Represents the fifth line of address, if applicable. |
| 10 | Town | C | 50 | Represents the name of the town. |
| 11 | Postcode | C | 10 | Represents the postcode of the location. |
| 12 | Longitude (if available) | C | 10 | Represents the longitude value for the office location, if applicable. |
| 13 | Latitude (if available) | C | 10 | Represents the latitude value for the office location, if applicable. |
| 14 | Monday Open 1 | D | 5 | Represents the first opening time on Monday in the hh:mm (24hr clock) format. |
| 15 | Monday Open 2 | D | 5 | Represents the second opening time on Monday in the hh:mm (24hr clock) format. Note: This record is left blank if the office has only one opening time. |
| 16 | Monday Open 3 | D | 5 | Represents the third opening time on Monday in the hh:mm (24hr clock) format. Note: This record is left blank if the office only has one or two opening times. |
| 17 | Monday Close 1 | D | 5 | Represents the first closing time on Monday in the hh:mm (24hr clock) format. |
| 18 | Monday Close 2 | D | 5 | Represents the second closing time on Monday in the hh:mm (i24hr clock) format. Note: This record is left blank if the office has only one closing time. |
| 19 | Monday Close 3 | D | 5 | Represents the third closing time on Monday in the hh:mm (24hr clock) format. Note: This record is left blank if the office has only one or two closing times. |
| 20 | Tuesday Open 1 | D | 5 | First opening time on Tuesday in format hh:mm (in 24hr clock format) |
| 21 | Tuesday Open 2 | D | 5 | Second opening time on Tuesday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 22 | Tuesday Open 3 | D | 5 | Third opening time on Tuesday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 23 | Tuesday Close 1 | D | 5 | First Closing time on Tuesday in format hh:mm (in 24hr clock format) |
| 24 | Tuesday Close 2 | D | 5 | Second Closing time on Tuesday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 25 | Tuesday Close 3 | D | 5 | Third Closing time on Tuesday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
| 26 | Wednesday Open 1 | D | 5 | First opening time on Wednesday in format hh:mm (in 24hr clock format) |
| 27 | Wednesday Open 2 | D | 5 | Second opening time on Wednesday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 28 | Wednesday Open 3 | D | 5 | Third opening time on Wednesday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 29 | Wednesday Close 1 | D | 5 | First Closing time on Wednesday in format hh:mm (in 24hr clock format) |
| 30 | Wednesday Close 2 | D | 5 | Second Closing time on Wednesday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 31 | Wednesday Close 3 | D | 5 | Third Closing time on Wednesday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
| 32 | Thursday Open 1 | D | 5 | First opening time on Thursday in format hh:mm (in 24hr clock format) |
| 33 | Thursday Open 2 | D | 5 | Second opening time on Thursday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 34 | Thursday Open 3 | D | 5 | Third opening time on Thursday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 35 | Thursday Close 1 | D | 5 | First Closing time on Thursday in format hh:mm (in 24hr clock format) |
| 36 | Thursday Close 2 | D | 5 | Second Closing time on Thursday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 37 | Thursday Close 3 | D | 5 | Third Closing time on Thursday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
| 38 | Friday Open 1 | D | 5 | First opening time on Friday in format hh:mm (in 24hr clock format) |
| 39 | Friday Open 2 | D | 5 | Second opening time on Friday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 40 | Friday Open 3 | D | 5 | Third opening time on Friday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 41 | Friday Close 1 | D | 5 | First Closing time on Friday in format hh:mm (in 24hr clock format) |
| 42 | Friday Close 2 | D | 5 | Second Closing time on Friday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 43 | Friday Close 3 | D | 5 | Third Closing time on Friday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
| 44 | Saturday Open 1 | D | 5 | First opening time on Saturday in format hh:mm (in 24hr clock format) |
| 45 | Saturday Open 2 | D | 5 | Second opening time on Saturday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 46 | Saturday Open 3 | D | 5 | Third opening time on Saturday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 47 | Saturday Close 1 | D | 5 | First Closing time on Saturday in format hh:mm (in 24hr clock format) |
| 48 | Saturday Close 2 | D | 5 | Second Closing time on Saturday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 49 | Saturday Close 3 | D | 5 | Third Closing time on Saturday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
| 50 | Sunday Open 1 | D | 5 | First opening time on Sunday in format hh:mm (in 24hr clock format) |
| 51 | Sunday Open 2 | D | 5 | Second opening time on Sunday in format hh:mm (in 24hr clock format) (will be blank if office only has one opening time) |
| 52 | Sunday Open 3 | D | 5 | Third opening time on Sunday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two opening times) |
| 53 | Sunday Close 1 | D | 5 | First Closing time on Sunday in format hh:mm (in 24hr clock format) |
| 54 | Sunday Close 2 | D | 5 | Second Closing time on Sunday in format hh:mm (in 24hr clock format) (will be blank if office only has one Closing time) |
| 55 | Sunday Close 3 | D | 5 | Third Closing time on Sunday in format hh:mm (in 24hr clock format) (will be blank if office only has one or two Closing times) |
Important
Each office can have up to a maximum of 3 opening windows in a day. Therefore, the open/close profiles for any day may vary as shown in the following tables.
| Name | Opening/closing times |
|---|---|
| Open 1 | 07:30 |
| Open 2 | 13:00 |
| Open 3 | 18:00 |
| Close 1 | 12:00 |
| Close 2 | 17:00 |
| Close 3 | 20:00 |
| Name | Opening/closing times |
|---|---|
| Open 1 | 07:30 |
| Open 2 | 13:00 |
| Open 3 | |
| Close 1 | 12:00 |
| Close 2 | 17:00 |
| Close 3 |
| Name | Opening/closing times |
|---|---|
| Open 1 | 07:30 |
| Open 2 | |
| Open 3 | |
| Close 1 | 18:00 |
| Close 2 | |
| Close 3 |
Note
For more information on how to use this API endpoint, refer to the PUDO Locations API reference.
Updated 25 days ago