Get PUDO Locations

get

https://api.intersoftsapient.net/v4/pudolocations/{carrierCode}/{countryCode}/{postcode}

The Get PUDO Locations endpoint returns a list of PUDO Locations that are within a set radius of the postcode provided in the request. That radius is set to 10 Miles / 16.09 Kilometres.
This endpoint must be called before the Create Shipment endpoint to select a PUDO location, and the PUDO location details are then provided in the Create Shipment request.
The endpoint currently only supports Royal Mail and InPost.

Path Params

carrierCode

string

required

Carrier Code
Example: RM

countryCode

string

required

length between 2 and 2

2 Digit ISO Country Code, per ISO 3166 Standard

postcode

string

required

length ≤ 10

Recipient Postcode.
This will be used to retrieve the available PUDO locations

Query Params

maximumResults

int32

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.

Note: If this value is not specified, then by default, a maximum of 10 PUDO locations will be returned in a single request.

locationServices

string

This parameter specifies the available at each PUDO location. It accepts the following values based on the options provided by the location:

Pickup: Indicates that customers can collect their parcels from the location.
Dropoff: Indicates that the customers can drop off parcels for shipment at the location.
Printinstore: Indicates that the location offers printing services for shipping labels, allowing customers to print their labels directly at the store.

Note: If a service is selected, then the locations offering only the requested service will be returned in the response.

enhancedLocationDetails

boolean

Defaults to false

This boolean parameter specifies whether the response includes additional detail about each PUDO location in the form of enhancedLocationDetails object.

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 insist customers in making informed decisions.
If set to false, the response will be limited to the basic details of the PUDO locations without the enhanced attributes.

Note: By default, this field is set to false.

Responses

401

Unauthorized

403

Forbidden

404

The carrier code was not found.

500

Internal Server Error

200Success

400Invalid request response.