Nothing Found
    Nothing Found
Locations API
Version 2.3.0

getPointsByType

This endpoint returns a list of all points associated with a specific Australia Post point_type

SecurityAUTH-KEY
Request
path Parameters
points_type
required
string

The point's type. There are six of these enumerated values, to select from:

  • UPL: Parcel lockers.
  • R_SPB: A red street post box.
  • C_SPB: Combined street post boxes (Both red and yellow boxes together).
  • PO: An Australia Post outlet.
  • OS: Outstation (These are a part of a post office not in the same physical building. For example, a separate building dedicated to PO boxes.)
  • DC: A delivery centre.
Enum: "PO" "UPL" "R_SPB" "C_SPB" "OS" "DC"
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

OK

get/points/type/{points_type}
Request samples 
Response samples 
application/json
{
  • "points": [
    ]
}