getPointsByLocationCode

Nothing Found

Locations API

Version 2.3.0

getPointsByLocationCode

This endpoint returns a list of all points associated with a specific Australia Post location_code. A location_code is a unique alphanumeric identification code that represents an Australia Post facility.

SecurityAUTH-KEY

Request

path Parameters

location_code

required

string

See the endpoint description above.

query Parameters

pc	string A partner code identifies an entity that owns location data. Currently we offer access only to Australia Post outlet and services data. In the future we may expand this to include location data from partner providers. Note: If this field is left empty, the default value is "AP". Submitting any other value will return an empty data set.
usage_types	string The usage_types parameter is an optional comma-separated string used to filter locations by its usage type. The filter works as an OR condition, meaning locations matching any of the specified values will be returned. If omitted, all locations will be returned. Example: usage_types=1,2

Responses

200

get/points/{location_code}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"points": [{"location_code": "350748_PO",
"partner_code": "AP",
"name": "MELBOURNE GPO POST SHOP",
"type": "PO",
"description": "Post Office",
"phone_number": "13 13 18",
"fax_number": "(03)9203 3040",
"address": {"address_line_1": "The Strand",
"address_line_2": "Shop 1 250 Elizabeth Street",
"suburb": "Melbourne",
"state": "VIC",
"postcode": "3000",
"country_name": "Australia",
"country_code": "AUS"
},
"geo_location": {"lat": -37.812679,
"lon": 144.962732
},
"delivery_point_id": 34038295,
"work_centre_id": 350748,
"hatch_description": "In the PO Box Suite",
"service_codes": ["108",
"9",
"33",
"17",
"6"
],
"hours": [{"type": "HOURS",
"weekday": "0",
"start_time": "09:00",
"end_time": "17:00"
},
{"type": "HOURS",
"weekday": "1",
"start_time": "09:00",
"end_time": "17:00"
}
]
}
]
}