getWorkCentres

Nothing Found

Locations V3 API

Version 3.0.0

getWorkCentres

This endpoint returns a list of all Australia Post workcentres. You can filter your results using the query parameter.

SecurityAUTH-KEY

Request

query Parameters

offset	integer Default: 0 Pagination offset.
size	integer <= 100 Default: 20 Pagination size.
type	string The type parameter is an optional string of comma-delimited values denoting which outlets and facilities you want to locate. There are six of these enumerated values, all of which are selected by default: 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"
lat	number <double> A coordinate representing the angular distance in degrees, minutes and seconds, of a point east or west of the Greenwich Meridian, expressed as a double.
lon	number <double> A coordinate representing the angular distance in degrees, minutes and seconds, of a point east or west of the Greenwich Meridian, expressed as a double.
radius	integer [ 0 .. 1000 ] Default: 50 The radius in kilometres, to search around the provided latitude/longitude coordinate point.
location[addresses.attributes.postcode]	string^[0-9]{4}$ A four-digit number that forms part of a postal address in Australia.
location[addresses.attributes.dpid]	string DPID (Delivery Point Identifier)
attribute[work_centre_id]	string Work centre ID.
attribute[access_restriction_code]	string Access restriction code for parcel lockers. Example: attribute[access_restriction_code]=AL, RD, UD, NA
attribute[location_type_code]	string Location type code for parcel lockers. Example: attribute[location_type_code]=GL, HN, MY, RL, NA
attribute[operational_capabilities.id]	string Operational capability ID.
location[addresses.type]	Array of strings Filter workcentres where workcentre has at least one address matching any of the provided types.
location[addresses.type:all]	Array of strings Filter workcentres where workcentre has ALL of the specified address types.

Responses

200

400

Bad Request

401

Unauthorised

404

Not found

405

Method not allowed

429

Too many requests

500

Internal server error

503

Service unavailable

get/workcentres

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"pagination": {"total": 1,
"offset": 0,
"size": 1
},
"workcentres": [{"id": "96286800_UPL",
"type": "UPL",
"attributes": {"business_name": "Melbourne Galleria Pcl Lkrs",
"business_long_name": "Melbourne Galleria Parcel Lockers",
"work_centre_id": "123412",
"access_restriction_code": "AL",
"location_type_code": "GL",
"org_unit_type_description": "Delivery Facility",
"operational_capabilities": [{"id": "ACCESS_HOURS",
"attributes": {"name": "Standard Opening Hours",
"description": "Available 24x7",
"current_hours": {"periods": [{"day": "MON",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "TUE",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "WED",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "THU",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "FRI",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "SAT",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
},
{"day": "SUN",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
},
"type": "STANDARD"
}
]
},
"standard_hours": {"periods": [{"day": "MON",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "TUE",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "WED",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "THU",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "FRI",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "SAT",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
},
{"day": "SUN",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 23,
"minute": 59
}
}
]
}
}
}
]
},
"location": {"attributes": {"lat": -37.8171924,
"lon": 144.96002
},
"addresses": [{"type": "STREET",
"attributes": {"directions": "Parcel Locker is located inside the Post Shop opposite the PO Boxes.",
"address_line_1": "277 William St",
"suburb": "MELBOURNE",
"state": "VIC",
"postcode": "3000",
"country_name": "Australia",
"country_code": "AU",
"dpid": "1234"
}
},
{"type": "PARCEL_LOCKER",
"attributes": {"directions": "Parcel Locker is located inside the Post Shop opposite the PO Boxes.",
"address_line_1": "Parcel Locker 118",
"address_line_2": "William St",
"suburb": "MELBOURNE",
"state": "VIC",
"postcode": "3000",
"country_name": "Australia",
"country_code": "AU",
"dpid": "1234"
}
}
]
}
},
{"id": "337586_PO",
"type": "PO",
"attributes": {"business_long_name": "MELBOURNE GPO COLLINS STREET WEST",
"business_name": "MELB GPO COLLINS ST WEST PS",
"phone_number": "(03) 8698 5126",
"fax_number": "(03)8698 5129",
"work_centre_id": "331088",
"org_unit_type_description": "Post Office",
"operational_capabilities": [{"id": "ACCESS_HOURS",
"attributes": {"name": "Standard Opening Hours",
"current_hours": {"periods": [{"day": "MON",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
},
"type": "STANDARD"
},
{"day": "TUE",
"open": {"hour": 10,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
},
"type": "TEMP"
},
{"day": "WED",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 12,
"minute": 30
},
"type": "STANDARD"
},
{"day": "WED",
"open": {"hour": 13,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
},
"type": "STANDARD"
},
{"day": "THU",
"type": "SPECIAL"
},
{"day": "FRI",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
},
"type": "STANDARD"
},
{"day": "SAT",
"open": {"hour": 10,
"minute": 0
},
"close": {"hour": 15,
"minute": 0
},
"type": "STANDARD"
},
{"day": "SUN",
"type": "STANDARD"
}
]
},
"standard_hours": {"periods": [{"day": "MON",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
}
},
{"day": "TUE",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
}
},
{"day": "WED",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
}
},
{"day": "THU",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
}
},
{"day": "FRI",
"open": {"hour": 8,
"minute": 30
},
"close": {"hour": 17,
"minute": 30
}
},
{"day": "SAT",
"open": {"hour": 10,
"minute": 0
},
"close": {"hour": 15,
"minute": 0
}
},
{"day": "SUN",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 0,
"minute": 0
}
}
]
}
}
},
{"id": "HATCH",
"attributes": {"name": "Hatch Access Hours",
"description": "Adjacent to PO Boxes on Gurners Lane.",
"current_hours": {"periods": [{"day": "MON",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
},
"type": "STANDARD"
},
{"day": "TUE",
"open": {"hour": 5,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
},
"type": "TEMP"
},
{"day": "WED",
"open": {"hour": 5,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
},
"type": "TEMP"
},
{"day": "THU",
"open": {"hour": 5,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
},
"type": "TEMP"
},
{"day": "FRI",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
},
"type": "STANDARD"
},
{"day": "SAT",
"type": "STANDARD"
},
{"day": "SUN",
"type": "STANDARD"
}
]
},
"standard_hours": {"periods": [{"day": "MON",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
}
},
{"day": "TUE",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
}
},
{"day": "WED",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
}
},
{"day": "THU",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
}
},
{"day": "FRI",
"open": {"hour": 6,
"minute": 0
},
"close": {"hour": 9,
"minute": 30
}
},
{"day": "SAT",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 0,
"minute": 0
}
},
{"day": "SUN",
"open": {"hour": 0,
"minute": 0
},
"close": {"hour": 0,
"minute": 0
}
}
]
}
}
},
{"id": "ATM",
"attributes": {"name": "ATM",
"description": "ATM",
"service_offering": true,
"categories": [{"id": "finance_insurance",
"name": "Finance & insurance"
}
]
}
},
{"id": "Passport_Interviews",
"attributes": {"name": "Australian Passport",
"description": "abc",
"service_offering": true,
"categories": [{"id": "passports_travel",
"name": "Passports & travel"
},
{"id": "handy_services",
"name": "Handy Services"
}
]
}
}
]
},
"location": {"attributes": {"lat": -37.8171924,
"lon": 144.96002
},
"addresses": [{"type": "STREET",
"attributes": {"directions": "Big old building, cant miss it",
"address_line_1": "Ground Floor 440 Collins Street",
"suburb": "MELBOURNE",
"state": "VIC",
"postcode": "3000",
"country_name": "Australia",
"country_code": "AU",
"dpid": "1234"
}
},
{"type": "PARCEL_COLLECT",
"attributes": {"directions": "Next to the lift",
"address_line_1": "Melbourne GPO Post Office",
"address_line_2": "Bourke Street",
"suburb": "MELBOURNE",
"state": "VIC",
"postcode": "3000",
"country_name": "Australia",
"country_code": "AU",
"dpid": "1234"
}
}
]
}
}
]
}