Local Collect is a delivery enhancement to Royal Mail Tracked & Special Delivery Guaranteed products that enables customers to benefit from ‘Click and Collect’ options by having their parcels delivered to participating Post Offices and Royal Mail Customer Service Points. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and Royal Mail Customer Service Points, where the item can be held awaiting collection. There are no costs to customers for using the Local Collect API services, however development costs must be covered by the customer. Royal Mail will not accept any responsibility for these development, implementation and testing costs.
| Attachment | Size |
|---|---|
 local_collect_widget_technical_implementation_guide_v2.1_2.docx | 1.7 MB |
 rmg_local_collect_api_rest_technical_user_guide_v1_2_0.pdf | 463.02 KB |
 local_collect_rest_v_2.yaml | 7.9 KB |
Custom API Endpoint
Paths
/{postcode}
Gets Local Collect POL or EO Branch objects.Mandatory path param postCode determinesthe epicentre of the search radius
Radius in miles. Max 10.
{
"default": "{radius}"
}'Post Office' or 'Enquiry Office'
{
"default": "{type}"
}Successful response
Bad Request. Probably malformed request
Authorisation failure
Resource not found
Too many requests
Internal Server Error
Service Unavailable
Gateway Timeout
/geo/spatial
Search By Geo Lookup
This operation provides the location based on the latitude and longitude which are part of the query parameters
Search Radius in miles. Max 10.
{
"default": "{radius}"
}Longitude. Can use float/decimal
{
"default": "{longitude}"
}Latitude. Can use float/decimal
{
"default": "{latitude}"
}'Post Office' or 'Enquiry Office'
{
"default": "{type}"
}Definitions
{
"type": "object",
"properties": {
"locations": {
"type": "array",
"items": {
"$ref": "#/definitions/location"
}
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/definitions/warningResponse"
}
}
}
}
{
"type": "object",
"properties": {
"organisationName": {
"type": "string",
"example": "Royal Mail Group Ltd"
},
"locationName": {
"type": "string",
"example": "South Lambeth"
},
"addressLine1": {
"type": "string",
"example": "333 Wandsworth Road"
},
"addressLine2": {
"type": "string",
"example": "Mulberry Street"
},
"addressLine3": {
"type": "string",
"example": "Near Plain Office"
},
"city": {
"type": "string",
"example": "London"
},
"county": {
"type": "string",
"example": "Cleveland"
},
"postcode": {
"type": "string",
"example": "SW82JG"
},
"openingHours": {
"type": "array",
"items": {
"$ref": "#/definitions/openingHours"
}
},
"geoLocation": {
"$ref": "#/definitions/geoLocation"
},
"distance": {
"type": "integer",
"example": "0.61"
},
"facilities": {
"$ref": "#/definitions/facilities"
},
"locationType": {
"type": "string",
"pattern": "Enquiry Office|Post Office",
"example": "Enquiry Office"
}
},
"additionalProperties": true
}
{
"type": "object",
"properties": {
"customerParkingIndicator": {
"type": "boolean",
"example": "false"
},
"disabilityIndicator": {
"type": "boolean",
"example": "true"
}
}
}
{
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "float",
"example": 51.4756
},
"longitude": {
"type": "number",
"format": "number",
"example": -0.1304
}
}
}
{
"type": "object",
"properties": {
"dayOfWeek": {
"type": "string",
"example": "Monday"
},
"openingTime": {
"type": "string",
"example": "08:00:00"
},
"closingTime": {
"type": "string",
"example": "13:00:00"
},
"lunchHours": {
"$ref": "#/definitions/lunchHours"
}
}
}
{
"type": "object",
"properties": {
"lunchOpening": {
"type": "string",
"example": "08:00:00"
},
"lunchClosing": {
"type": "string",
"example": "13:00:00"
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "number"
},
"status": {
"type": "number"
},
"description": {
"type": "string"
},
"cause": {
"type": "string"
},
"resolution": {
"type": "string"
},
"context": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "object",
"example": "E1001"
},
"description": {
"type": "string",
"example": "Postcode SW8 2HG1 invalid"
},
"cause": {
"type": "string",
"example": "Post Code is not a recognised UK Post Code"
},
"resolution": {
"type": "string",
"example": "Resubmit query with a valid Postcode. Alternatively submit with valid Latitude/Longitude coordinates"
},
"context": {
"type": "string",
"example": "Client"
}
}
}