production
development
https://pp.api.royalmail.net
Preprod Custom Endpoint
Paths
/
get /
Locates the delivery office for a given UK Postcode.
Enter a postcode in the URL and the response JSON will contain the name, the address and the business hours of the Delivery Office dedicated to this postcode.
To use this operation you must use one of the following sets of security requirements.
Client ID
X-IBM-Client-Id
(apiKey located in header)
Client Secret
X-IBM-Client-Secret
(apiKey located in header)
Client ID
X-IBM-Client-Id
(apiKey located in header)
Bearer
Bearer
(oauth2 password)
Scopes
guid
postcode
Required in query
string
Enter UK Postcode to locate a delivery office for.
{
"default": "{postcode}"
}Accept
Optional in header
string
application/json
200
Successful query
{
"schema": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"responseDate": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
}
},
"searchedPostcode": {
"type": "string"
},
"deliveryOffice": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"officeDetails": {
"type": "object",
"properties": {
"name": {
"type": "string"
400
Bad request, invalid or incorrectly formatted postcode.
{
"headers": [],
"examples": {
"application\/json": {
"httpCode": "400",
"httpMessage": "Bad Request",
"moreInformation": "Invalid UK Postcode"
}
},
"schema": {
"type": "object",
"properties": {
"httpCode": {
"type": "string"
},
"httpMessage": {
"type": "string"
},
"moreInformation": {
"type": "string"
}
}
}
}404
Invalid Postcode
{
"headers": [],
"examples": {
"application\/json": {
"httpCode": "404",
"httpMessage": "Not Found",
"moreInformation": "eBDofApi001 - No Delivery Office Found for postcode"
}
},
"schema": {
"type": "object",
"properties": {
"httpCode": {
"type": "string"
},
"httpMessage": {
"type": "string"
},
"moreInformation": {
"type": "string"
}
}
}
}Example Request
Example Response
GET https://pp.api.royalmail.net/deliveryOffices/
Try this operation
Definitions
[]