{
    "componentChunkName": "component---src-templates-redoc-operation-js",
    "path": "/openapi/partner/locations/operation/getServicesUsingGET/",
    "result": {"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/partner/locations/operation/getServicesUsingGET/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Locations API\",\"description\":\"Use a postcode or global positioning coordinates to find Australia Post outlets and services.<br />Outlets include: <ul><li>post offices</li><li>street post boxes</li><li>parcel lockers</li><li>PO boxes</li><li>delivery centres</li></ul> Filter your results to locate the most relevant outlets and the services they provide, anywhere in Australia.\",\"version\":\"2.3\",\"x-short-desc\":\"Use a postcode or coordinates to find Australia Post outlets and services.\",\"x-api-key\":\"locations\",\"x-gateway-type\":\"AWS_GATEWAY\",\"x-api-id\":\"locations_v2.3.0-rev.13\"},\"servers\":[{\"url\":\"https://{api_base_url_domain}/locations/v2\",\"variables\":{\"api_base_url_domain\":{\"default\":\"digitalapi.auspost.com.au\"}}}],\"security\":[{\"AUTH-KEY\":[]}],\"paths\":{\"/points/postcode/{postcode}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByPostcode\",\"description\":\"This endpoint returns a list of all Australia Post points within a specific post code area. You can filter your results using the types parameter.\",\"operationId\":\"getGeoLocationsByPostCodeUsingGET\",\"parameters\":[{\"name\":\"postcode\",\"in\":\"path\",\"description\":\"A four-digit Australian postcode.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"maximum\":9999,\"minimum\":0,\"type\":\"integer\"}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"},{\"$ref\":\"#/components/parameters/types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"multiple-points-returned-of-different-types\":{\"$ref\":\"#/components/examples/multiple-points-returned-of-different-types\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by postcode\"}},\"/points/workcentres/{work_centre_id}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByWorkCenterID\",\"description\":\"This endpoint returns a list of all points associated with a specific Australia Post work centre's. You can filter your results using the types parameter. \\n \\n A work center is a unique numeric identification code that represents a parent Australia Post facility, and all of the child point objects (assets or facilities) associated with it. The facility and its point objects all share the same work_centre_id, but each point is unique.\",\"operationId\":\"getGeoLocationsByWcidUsingGET\",\"parameters\":[{\"name\":\"work_centre_id\",\"in\":\"path\",\"description\":\"See the endpoint description above.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"maximum\":999999999,\"minimum\":0,\"type\":\"integer\"}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"},{\"$ref\":\"#/components/parameters/types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"multiple-points-returned-of-different-types\":{\"$ref\":\"#/components/examples/multiple-points-returned-of-different-types\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by workcentreid\"}},\"/points/deliverypoints/{delivery_point_id}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByDeliveryPointId\",\"description\":\"This endpoint returns a list of all points associated with a specific Australia Post delivery_point_id. You can filter your results using the types parameter. A delivery_point_id is a unique numeric identification code that represents a point to which Australia Post delivers or receives deliveries.\",\"operationId\":\"getGeoLocationsByDeliveryPointIdUsingGET\",\"parameters\":[{\"name\":\"delivery_point_id\",\"in\":\"path\",\"description\":\"See the endpoint description above.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"maxLength\":9,\"type\":\"string\"}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"},{\"$ref\":\"#/components/parameters/types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"getPostOfficeByDeliveryPointId\":{\"$ref\":\"#/components/examples/single-po-returned\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by deliverypointid\"}},\"/points/{location_code}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByLocationCode\",\"description\":\"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.\",\"operationId\":\"getPointsByLocationCodeUsingGET\",\"parameters\":[{\"name\":\"location_code\",\"in\":\"path\",\"description\":\"See the endpoint description above.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"getPostOfficeByLocationCode\":{\"$ref\":\"#/components/examples/single-po-returned\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by location code\"}},\"/points/type/{points_type}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByType\",\"description\":\"This endpoint returns a list of all points associated with a specific Australia Post point_type\",\"operationId\":\"getPointsByTypeUsingGET\",\"parameters\":[{\"name\":\"points_type\",\"in\":\"path\",\"description\":\"The point's type. There are six of these enumerated values, to select from: \\n * UPL: Parcel lockers. \\n * R_SPB: A red street post box. \\n * C_SPB: Combined street post boxes (Both red and yellow boxes together). \\n * PO: An Australia Post outlet. \\n * 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.) \\n * DC: A delivery centre.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"enum\":[\"PO\",\"UPL\",\"R_SPB\",\"C_SPB\",\"OS\",\"DC\"]}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"getPostOffices\":{\"$ref\":\"#/components/examples/single-po-returned\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by location code\"}},\"/points/geo/{longitude}/{latitude}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getPointsByGeoCoordinates\",\"description\":\"This endpoint returns a list of all Australia Post points within a given range of the coordinates provided. Results are ordered by the distance field, from closest to farthest away. You can filter your results using the various parameters shown below.\",\"operationId\":\"getGeoLocationsUsingGET\",\"parameters\":[{\"name\":\"longitude\",\"in\":\"path\",\"description\":\"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.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\"}},{\"name\":\"latitude\",\"in\":\"path\",\"description\":\"A coordinate representing the angular distance in degrees, minutes and seconds, of a point north or south of the equator, expressed as a double.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\"}},{\"$ref\":\"#/components/parameters/pc\"},{\"$ref\":\"#/components/parameters/usage_types\"},{\"name\":\"radius\",\"in\":\"query\",\"description\":\"The radius in kilometres, to search around the provided latitude/longitude coordinate point. The default value is 50, and the hard limit is 1000Km.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":1000,\"minimum\":0,\"type\":\"integer\"}},{\"name\":\"services\",\"in\":\"query\",\"description\":\"A comma-delimited string of service codes by which to filter the returned list of matching locations. **Note: ** A list of current services is available through the getServices endpoint.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"limit\",\"in\":\"query\",\"description\":\"The maximum number of results to return. The default value is 5.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":10000,\"minimum\":0,\"type\":\"integer\"}},{\"$ref\":\"#/components/parameters/types\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PointsResponse\"},\"examples\":{\"multiple-points-returned-of-different-types\":{\"$ref\":\"#/components/examples/multiple-points-returned-of-different-types\"}}}}}}},\"x-info\":{\"pathLabel\":\"points by long and lat\"}},\"/services\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getServices\",\"description\":\"This endpoint returns a list of all available services. The service code in each returned service object can be passed as a parameter when calling getServicesByServiceCodes or getPointsByGeoCoordinates endpoints.\",\"operationId\":\"getServicesUsingGET\",\"parameters\":[{\"$ref\":\"#/components/parameters/pc\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"services\":{\"type\":\"array\",\"description\":\"An array of service objects. A service object is a data structure returned from calls to the /services endpoint, and represents an Australia Post service that might be available at one of its outlets or facilities. There are no parameters by which to filter the service objects returned from the /service endpoint. \\n \\n **Note:** Not all outlets and facilities offer all services, and the number of service objects returned may change if Australia Post increases or decreases the number of services it offers.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The name of the service.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service expressed as an enumerated value.\"},\"appointment_required\":{\"type\":\"boolean\",\"description\":\"A value indicating if a customer must first make an appointment for the requested service.\"},\"categories\":{\"type\":\"array\",\"description\":\"An array of objects that describe the service category to which a specific service belongs.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the name field.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service category to which a service belongs.\"}},\"description\":\"This object contains the name of a service category used to group services of a similar type.\"}},\"searchable\":{\"type\":\"boolean\",\"description\":\"A value dictating whether or not a specific service will be presented in the response to a service query.\"},\"partner_code\":{\"type\":\"string\",\"description\":\"A code to identify the owner entity of the assets, facilities or services referred to by the location_code. This value is currently always \\\"AP\\\" (Australia Post), however, this may be expanded in future to include other entities.\"},\"service_code\":{\"type\":\"integer\",\"description\":\"A unique number identifying a specific service that is available at a location. For example, \\\"99\\\" that identifies the PostBillPay service.\",\"format\":\"int32\"},\"url_name\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the description field.\"}},\"description\":\"A Service object describes a specific service that might be available from an Australia Post outlet or facility.  **Note:** \\n Not all outlets and facilities offer all of the services returned by the getServices endpoint.\"}}}},\"examples\":{\"example1\":{\"summary\":\"Parcel collection outside standard hours\",\"value\":{\"services\":[{\"service_code\":1,\"partner_code\":\"AP\",\"name\":\"parcel-pickup-outside-standard-hours\",\"description\":\"Parcel collection outside standard hours\",\"appointment_required\":false,\"searchable\":false,\"url_name\":\"parcel-pickup-outside-standard-hours\",\"categories\":[{\"name\":\"opening_hours\",\"description\":\"Opening hours\"},{\"name\":\"parcels_mail\",\"description\":\"Parcels & mail\"}]}]}}}}}}}},\"x-info\":{\"pathLabel\":\"services\"}},\"/services/{service_codes}\":{\"get\":{\"tags\":[\"Endpoints\"],\"summary\":\"getServicesByServiceCodes\",\"description\":\"This endpoint returns an array of services based on a comma-delimited list of service codes supplied in the request. **Note: ** A list of all current service codes is available from the getServices endpoint.\",\"operationId\":\"getServicesByServiceCodesUsingGET\",\"parameters\":[{\"name\":\"service_codes\",\"in\":\"path\",\"description\":\"A comma-delimited list of service codes by which to filter the returned list of matching locations.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}},{\"$ref\":\"#/components/parameters/pc\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"services\":{\"type\":\"array\",\"description\":\"An array of service objects. A service object is a data structure returned from calls to the /services endpoint, and represents an Australia Post service that might be available at one of its outlets or facilities. There are no parameters by which to filter the service objects returned from the /service endpoint. \\n \\n **Note:** Not all outlets and facilities offer all services, and the number of service objects returned may change if Australia Post increases or decreases the number of services it offers.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The name of the service.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service expressed as an enumerated value.\"},\"appointment_required\":{\"type\":\"boolean\",\"description\":\"A value indicating if a customer must first make an appointment for the requested service.\"},\"categories\":{\"type\":\"array\",\"description\":\"An array of objects that describe the service category to which a specific service belongs.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the name field.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service category to which a service belongs.\"}},\"description\":\"This object contains the name of a service category used to group services of a similar type.\"}},\"searchable\":{\"type\":\"boolean\",\"description\":\"A value dictating whether or not a specific service will be presented in the response to a service query.\"},\"partner_code\":{\"type\":\"string\",\"description\":\"A code to identify the owner entity of the assets, facilities or services referred to by the location_code. This value is currently always \\\"AP\\\" (Australia Post), however, this may be expanded in future to include other entities.\"},\"service_code\":{\"type\":\"integer\",\"description\":\"A unique number identifying a specific service that is available at a location. For example, \\\"99\\\" that identifies the PostBillPay service.\",\"format\":\"int32\"},\"url_name\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the description field.\"}},\"description\":\"A Service object describes a specific service that might be available from an Australia Post outlet or facility.  **Note:** \\n Not all outlets and facilities offer all of the services returned by the getServices endpoint.\"}}}},\"examples\":{\"example1\":{\"summary\":\"Example services\",\"value\":{\"services\":[{\"service_code\":3,\"partner_code\":\"AP\",\"name\":\"Special\",\"description\":\"Open before 9.00am weekdays\",\"appointment_required\":false,\"searchable\":false,\"url_name\":\"open-before-900am-weekdays\",\"categories\":[{\"name\":\"opening_hours\",\"description\":\"Opening hours\"}]},{\"service_code\":6,\"partner_code\":\"AP\",\"name\":\"Boxes_Available\",\"description\":\"PO Boxes available\",\"appointment_required\":false,\"searchable\":false,\"url_name\":\"po-boxes-available\",\"categories\":[{\"name\":\"parcels_mail\",\"description\":\"Parcels & mail\"}]}]}}}}}}}},\"x-info\":{\"pathLabel\":\"services by service codes\"}}},\"components\":{\"schemas\":{\"Point\":{\"type\":\"object\",\"properties\":{\"address\":{\"description\":\"An object that contains full street address information for a specific Australia Post outlet or facility.\",\"allOf\":[{\"$ref\":\"#/components/schemas/Address\"}]},\"delivery_point_id\":{\"type\":\"integer\",\"description\":\"A unique numeric identification code that represents a point to which Australia Post delivers or receives deliveries.\",\"format\":\"int32\"},\"usage_type\":{\"type\":\"string\",\"description\":\"The usage_type field specifies the access level for a location point.\\nFor parcel lockers (type=UPL):\\n* \\\"1\\\": Accessible to both registered and unregistered users.\\n* \\\"2\\\": Accessible only to registered users.\"},\"description\":{\"type\":\"string\",\"description\":\"The name of the point, described as a generic type. For example, \\\"Post Office\\\".\"},\"directions\":{\"type\":\"string\",\"description\":\"A text description of where parcel lockers can be found at a location. For example, \\\"Parcel locker is in the 24/7 area of Melbourne Bourke Street shop.\\\". **Note:** This field is only displayed if the point object is of type UPL (Parcel locker).\"},\"fax_number\":{\"type\":\"string\",\"description\":\"An Australian fax number.\"},\"geo_location\":{\"type\":\"object\",\"properties\":{\"lat\":{\"type\":\"number\",\"description\":\"The global positioning latitude coordinate for a location. For example, 144.9696466.\",\"format\":\"double\"},\"lon\":{\"type\":\"number\",\"description\":\"The global positioning longitude coordinate for a location. For example, -37.8126618.\",\"format\":\"double\"},\"distance\":{\"type\":\"number\",\"description\":\"The distance in kilometres to a matching point from the coordinates provided in the endpoint request. **Note:** This field is displayed in the results for all endpoints that require you to provide longitude and latitude coordinates.\",\"format\":\"double\"}},\"description\":\"An object containing the precise coordinate location of an Australia Post outlet or facility.\"},\"hatch_description\":{\"type\":\"string\",\"description\":\"A hatch is a customer service window in an Australia Post parcel pickup location. If a point has an associated hatch, this field may contain extra information specific to that hatch.\"},\"hours\":{\"type\":\"array\",\"description\":\"An array of objects that describe the hours of operation or availability of services at a location.\",\"items\":{\"allOf\":[{\"$ref\":\"#/components/schemas/Hour\"}]}},\"location_code\":{\"type\":\"string\",\"description\":\"A unique identification code for a specific Australia Post asset or facility (See the type field below.).\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the point in all uppercase characters. For example, \\\"MELBOURNE GPO POST SHOP\\\".\"},\"partner_code\":{\"type\":\"string\",\"description\":\"A code to identify the owner entity of the assets, facilities or services referred to by the location_code. This value is currently always \\\"AP\\\" (Australia Post), however, this may be expanded in future to include other entities.\"},\"phone_number\":{\"type\":\"string\",\"description\":\"An Australian telephone number.\"},\"service_codes\":{\"type\":\"array\",\"description\":\"A comma-delimited string of service IDs that identify the services available at a point. For more information about services, see the getServices endpoint\",\"items\":{\"type\":\"string\"}},\"type\":{\"type\":\"string\",\"description\":\"A single enumerated value denoting a service type available at a requested location. When multiple types are available at one location, a separate point object is returned for each one. There are six possible types: \\n * UPL: Parcel lockers. \\n * R_SPB: A red street post box. \\n * C_SPB: Combined street post boxes (Both red and yellow boxes together). \\n * PO:  An Australia Post outlet. \\n * 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.) \\n * DC:  A delivery centre.\"},\"work_centre_id\":{\"type\":\"integer\",\"description\":\"A unique numeric identification code that represents a parent Australia Post facility, and all of the child point objects (assets or facilities) associated with it. The facility and its point objects all share the same work_centre_id, but each point is unique.\",\"format\":\"int32\"}},\"description\":\"A point object is a descriptive record of an individual Australia Post outlet or facility, that includes location, contact and service availability data.\"},\"Address\":{\"properties\":{\"address_line_1\":{\"type\":\"string\",\"description\":\"Address line one.\"},\"address_line_2\":{\"type\":\"string\",\"description\":\"Address line two.\"},\"address_line_3\":{\"type\":\"string\",\"description\":\"Address line three.\"},\"country_code\":{\"type\":\"string\",\"description\":\"An alphabetical two-digit country identification code, as specified in the ISO 3166-2 standard.\"},\"country_name\":{\"type\":\"string\",\"description\":\"The name of the country (as written in English), represented by the country_code field.\"},\"postcode\":{\"type\":\"integer\",\"description\":\"A four-digit Australian postcode.\",\"format\":\"int32\"},\"state\":{\"type\":\"string\",\"description\":\"An Australian state name.\"},\"suburb\":{\"type\":\"string\",\"description\":\"An Australian suburb name.\"}},\"description\":\"An Address object contains full street address information for a specific Australia Post outlet or facility.\"},\"Location\":{\"properties\":{\"lat\":{\"type\":\"number\",\"description\":\"The global positioning latitude coordinate for a location. For example, 144.9696466.\",\"format\":\"double\"},\"lon\":{\"type\":\"number\",\"description\":\"The global positioning longitude coordinate for a location. For example, -37.8126618.\",\"format\":\"double\"},\"distance\":{\"type\":\"number\",\"description\":\"The distance in kilometres to a matching point from the coordinates provided in the endpoint request. **Note:** This field is displayed in the results for all endpoints that require you to provide longitude and latitude coordinates.\",\"format\":\"double\"}},\"description\":\"This object describes the precise location of an Australia Post outlet or facility. This object always returns latitude and longitude values for a point, although requests to the getPointsByGeoCoordinates endpoint will also include a distance value.\"},\"Hour\":{\"properties\":{\"end_date\":{\"type\":\"string\",\"description\":\"The end date of an operating period, when non-standard hours are observed. The date is returned in the format DD/MM/YYYY. For example, \\\"30/06/2016\\\".\"},\"end_time\":{\"type\":\"string\",\"description\":\"The time when an outlet or facility closes on a particular day, in the format hh:mm. For example, 23:15.\"},\"start_date\":{\"type\":\"string\",\"description\":\"The start date of an operating period, when non-standard hours are observed. The date is returned in the format DD/MM/YYYY. For example, \\\"29/06/2016\\\".\"},\"start_time\":{\"type\":\"string\",\"description\":\"The time when an outlet or facility opens on a particular day, in the format hh:mm. For example, 09:00.\"},\"type\":{\"type\":\"string\",\"description\":\"The hour type, representing the hours of operation at a location. There are six possible enumerated values: \\n * HOURS: Standard operating hours when a location is open. \\n * LUNCH: The lunchtime period when a location is closed. \\n * HATCH: The hours when the parcel pickup customer service counter is open. \\n * SPECIAL_HOURS   Non-standard operating hours at a location. \\n * SPECIAL_CLOSED  Non-standard closing times at a location. \\n * SPECIAL_LUNCH: A non-standard time when a location is closed for the lunchtime period. \\n **Note: ** Times are specific to the location of the point, expressed as local time at that point.\"},\"weekday\":{\"type\":\"integer\",\"description\":\"Day of the week, enumerated from Monday (0) to Sunday (6).\"}},\"description\":\"An Hour object describes a range of date and time-related information for a specific Australia Post outlet or facility.\"},\"Service\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The name of the service.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service expressed as an enumerated value.\"},\"appointment_required\":{\"type\":\"boolean\",\"description\":\"A value indicating if a customer must first make an appointment for the requested service.\"},\"categories\":{\"type\":\"array\",\"description\":\"An array of objects that describe the service category to which a specific service belongs.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the name field.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service category to which a service belongs.\"}},\"description\":\"This object contains the name of a service category used to group services of a similar type.\"}},\"searchable\":{\"type\":\"boolean\",\"description\":\"A value dictating whether or not a specific service will be presented in the response to a service query.\"},\"partner_code\":{\"type\":\"string\",\"description\":\"A code to identify the owner entity of the assets, facilities or services referred to by the location_code. This value is currently always \\\"AP\\\" (Australia Post), however, this may be expanded in future to include other entities.\"},\"service_code\":{\"type\":\"integer\",\"description\":\"A unique number identifying a specific service that is available at a location. For example, \\\"99\\\" that identifies the PostBillPay service.\",\"format\":\"int32\"},\"url_name\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the description field.\"}},\"description\":\"A Service object describes a specific service that might be available from an Australia Post outlet or facility.  **Note:** \\n Not all outlets and facilities offer all of the services returned by the getServices endpoint.\"},\"Category\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the name field.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service category to which a service belongs.\"}},\"description\":\"This object contains the name of a service category used to group services of a similar type.\"},\"PointsResponse\":{\"properties\":{\"points\":{\"type\":\"array\",\"description\":\"An array of point objects. A point object is a data structure returned from calls to Locations API endpoints, and represents the location of a specific Australia Post outlet or facility. The number of point objects returned depends on the endpoint used, and the parameters provided in the request.\",\"items\":{\"allOf\":[{\"$ref\":\"#/components/schemas/Point\"}]}}}},\"ServicesResponse\":{\"properties\":{\"services\":{\"type\":\"array\",\"description\":\"An array of service objects. A service object is a data structure returned from calls to the /services endpoint, and represents an Australia Post service that might be available at one of its outlets or facilities. There are no parameters by which to filter the service objects returned from the /service endpoint. \\n \\n **Note:** Not all outlets and facilities offer all services, and the number of service objects returned may change if Australia Post increases or decreases the number of services it offers.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The name of the service.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service expressed as an enumerated value.\"},\"appointment_required\":{\"type\":\"boolean\",\"description\":\"A value indicating if a customer must first make an appointment for the requested service.\"},\"categories\":{\"type\":\"array\",\"description\":\"An array of objects that describe the service category to which a specific service belongs.\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the name field.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the service category to which a service belongs.\"}},\"description\":\"This object contains the name of a service category used to group services of a similar type.\"}},\"searchable\":{\"type\":\"boolean\",\"description\":\"A value dictating whether or not a specific service will be presented in the response to a service query.\"},\"partner_code\":{\"type\":\"string\",\"description\":\"A code to identify the owner entity of the assets, facilities or services referred to by the location_code. This value is currently always \\\"AP\\\" (Australia Post), however, this may be expanded in future to include other entities.\"},\"service_code\":{\"type\":\"integer\",\"description\":\"A unique number identifying a specific service that is available at a location. For example, \\\"99\\\" that identifies the PostBillPay service.\",\"format\":\"int32\"},\"url_name\":{\"type\":\"string\",\"description\":\"The URL-encoded equivalent of the description field.\"}},\"description\":\"A Service object describes a specific service that might be available from an Australia Post outlet or facility.  **Note:** \\n Not all outlets and facilities offer all of the services returned by the getServices endpoint.\"}}}}},\"parameters\":{\"pc\":{\"name\":\"pc\",\"in\":\"query\",\"description\":\"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.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\"},\"x-hide\":true},\"usage_types\":{\"name\":\"usage_types\",\"in\":\"query\",\"description\":\"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.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"example\":\"1,2\"}},\"types\":{\"name\":\"types\",\"in\":\"query\",\"description\":\"The types 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: \\n * UPL: Parcel lockers. \\n * R_SPB: A red street post box. \\n * C_SPB: Combined street post boxes (Both red and yellow boxes together). \\n * PO: An Australia Post outlet. \\n * 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.) \\n * DC: A delivery centre.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"PO\",\"UPL\",\"R_SPB\",\"C_SPB\",\"OS\",\"DC\"]}}},\"examples\":{\"multiple-points-returned-of-different-types\":{\"summary\":\"Multiple points returned of different types\",\"value\":{\"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\"}]},{\"location_code\":\"63258302_UPL\",\"partner_code\":\"AP\",\"name\":\"Brisbane General Post Office Pcl Lkrs\",\"type\":\"UPL\",\"directions\":\"Parcel Locker is in 24/7 is area of Post Office Lane  between Queen and Elizabeth Streets.\",\"description\":\"Available 24/7\",\"address\":{\"address_line_1\":\"261 Queen Street\",\"suburb\":\"BRISBANE\",\"state\":\"QLD\",\"postcode\":\"4000\",\"country_name\":\"Australia\",\"country_code\":\"AU\"},\"geo_location\":{\"lat\":-27.468025,\"lon\":153.0281571},\"delivery_point_id\":63258302,\"work_centre_id\":430553,\"hours\":[{\"type\":\"HOURS\",\"weekday\":\"0\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"1\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"2\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"3\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"4\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"5\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"},{\"type\":\"HOURS\",\"weekday\":\"6\",\"start_time\":\"00:00\",\"end_time\":\"23:59:59\"}],\"usage_type\":\"1\",\"service_codes\":[]},{\"location_code\":\"RED0015373\",\"partner_code\":\"AP\",\"type\":\"R_SPB\",\"address\":{\"address_line_1\":\"61 Main Road\",\"suburb\":\"PERTH\",\"state\":\"TAS\",\"postcode\":\"7300\",\"country_name\":\"Australia\",\"country_code\":\"AU\"},\"geo_location\":{\"lat\":-41.576119,\"lon\":147.17379},\"work_centre_id\":736042,\"hours\":[],\"service_codes\":[]},{\"location_code\":\"RED0000480\",\"partner_code\":\"AP\",\"type\":\"C_SPB\",\"address\":{\"address_line_1\":\"River Side Off Mill Point Road\",\"address_line_2\":\"16 Mends Street\",\"suburb\":\"SOUTH PERTH\",\"state\":\"WA\",\"postcode\":\"6151\",\"country_name\":\"Australia\",\"country_code\":\"AU\"},\"geo_location\":{\"lat\":-31.97262,\"lon\":115.852525},\"hours\":[],\"service_codes\":[]},{\"location_code\":\"221356_OS\",\"partner_code\":\"AP\",\"name\":\"ACU CANBERRA PO BOX ANNEXE\",\"type\":\"OS\",\"description\":\"ACU CANBERRA PO BOX ANNEXE\",\"address\":{\"address_line_1\":\"223 Antill Street\",\"suburb\":\"WATSON\",\"state\":\"ACT\",\"postcode\":\"2602\",\"country_name\":\"Australia\",\"country_code\":\"AU\"},\"geo_location\":{\"lat\":-35.246284,\"lon\":149.15599},\"work_centre_id\":221356,\"hours\":[],\"service_codes\":[\"6\",\"7\"]},{\"location_code\":\"416153_DC\",\"partner_code\":\"AP\",\"name\":\"YATALA DC\",\"type\":\"DC\",\"description\":\"Delivery Centre\",\"phone_number\":\"13 13 18\",\"fax_number\":\"(07)3011 4084\",\"address\":{\"address_line_1\":\"3 Binary Street\",\"suburb\":\"YATALA\",\"state\":\"QLD\",\"postcode\":\"4207\",\"country_name\":\"Australia\",\"country_code\":\"AU\"},\"geo_location\":{\"lat\":-27.758184,\"lon\":153.239131},\"delivery_point_id\":36010322,\"work_centre_id\":416153,\"hours\":[{\"type\":\"HOURS\",\"weekday\":\"0\",\"start_time\":\"06:00\",\"end_time\":\"17:00\"},{\"type\":\"HOURS\",\"weekday\":\"1\",\"start_time\":\"06:00\",\"end_time\":\"17:00\"},{\"type\":\"HOURS\",\"weekday\":\"2\",\"start_time\":\"06:00\",\"end_time\":\"17:00\"},{\"type\":\"HOURS\",\"weekday\":\"3\",\"start_time\":\"06:00\",\"end_time\":\"17:00\"},{\"type\":\"HOURS\",\"weekday\":\"4\",\"start_time\":\"06:00\",\"end_time\":\"17:00\"}],\"service_codes\":[\"3\",\"7\",\"99\",\"6\",\"95\"]}]}},\"single-po-returned\":{\"summary\":\"Single PO point returned\",\"value\":{\"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\"}]}]}}},\"securitySchemes\":{\"AUTH-KEY\":{\"type\":\"apiKey\",\"name\":\"AUTH-KEY\",\"in\":\"header\"}}},\"x-strip-base-path\":false,\"x-allow-origins\":[\"*\"],\"x-allowed-headers\":[\"x-xhr-logon\",\"x-requested-with\"],\"x-categories\":[\"Geo\"],\"x-max-request-size\":128,\"x-common-responses\":{\"responses\":{\"400\":{\"description\":\"Bad request\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"400\",\"code\":\"CONSTRAINT_VIOLATION\",\"detail\":\"The server could not understand the request due to invalid syntax.\",\"source\":{\"parameter\":\"postcode\"}}]}}},\"401\":{\"description\":\"Unauthorised\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"401\",\"code\":\"UNAUTHORIZED\",\"detail\":\"Requests to this resource are only granted if they include a valid username and API key.\"}]}}},\"403\":{\"description\":\"Forbidden\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"403\",\"code\":\"FORBIDDEN\",\"detail\":\"Requests to this resource are forbidden without sufficient permissions.\"}]}}},\"404\":{\"description\":\"Not found\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"404\",\"code\":\"METHOD_NOT_FOUND\",\"detail\":\"The resource you requested is not available or does not exist.\"}]}}},\"405\":{\"description\":\"Method not allowed\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"405\",\"code\":\"METHOD_NOT_ALLOWED\",\"detail\":\"The wrong method (PUT, GET, POST, etc.) was used to request an endpoint. Only the GET method is supported.\"}]}}},\"415\":{\"description\":\"Unsupported media type\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"415\",\"code\":\"UNSUPPORTED_MEDIA_TYPE\",\"detail\":\"The uploaded object is in a format not supported by the API server or endpoint.\"}]}}},\"429\":{\"description\":\"Too many requests\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"429\",\"code\":\"TOO_MANY_REQUESTS\",\"detail\":\"The number of requests per second has exceeded the rate limit and your responses will be throttled temporarily.\"}]}}},\"500\":{\"description\":\"Internal server error\",\"examples\":{\"application/json\":{\"errors\":[{\"id\":\"500\",\"code\":\"INTERNAL_SERVER_ERROR\",\"detail\":\"The server could not complete the request due to an unexpected condition, and no more suitable message is available.\"}]}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"unstable_hideServerUrlInTryIt\":true,\"hideInfoSection\":false,\"hideInfoDescription\":false,\"noAutoAuth\":true,\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Node.js\"}]},\"labels\":{\"tryItAuth\":\"Credentials\"},\"unauthorizedTryIt\":{\"label\":\"Login to try it\",\"link\":\"/login\"},\"showRightPanelToggle\":false,\"showChangeLayoutButton\":false,\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi/partner/locations/overview/","redocItemId":"tag/Endpoints/operation/getServicesUsingGET","redocHasInfoPage":false,"settings":{"hideTryItPanel":false,"unstable_hideServerUrlInTryIt":true,"pagination":"item","hideInfoSection":false,"hideInfoDescription":false,"noAutoAuth":true,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"}]},"labels":{"tryItAuth":"Credentials"},"unauthorizedTryIt":{"label":"Login to try it","link":"/login"},"showRightPanelToggle":false,"showChangeLayoutButton":false},"requestLogin":false,"lastModified":"1775021326265"},"seo":{"title":"getServices"}}},"pageContext":{"id":"be711fbd-9b84-5e30-9ad9-c55bb685a959operation/getServicesUsingGET__redocly content/openapi/partner/locations/operation/getServicesUsingGET/","seo":{"title":"getServices","description":"This endpoint returns a list of all available services. The service code in each returned service object can be passed as a parameter when calling getServicesByServiceCodes or getPointsByGeoCoordinates endpoints.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/partner/locations.page.yaml#operation/getServicesUsingGET","pageBaseUrl":"/openapi/partner/locations","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/partner/locations/operation/getServicesUsingGET/","sidebarName":"reference_locations","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"locations_2.3.0","id":"2.3.0","title":"2.3.0","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},
    "staticQueryHashes": ["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}