PointsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/australia-post/main/json-schema/australia-post-points-response-schema.json",
  "title": "PointsResponse",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/australia-post-endpoints-api-openapi.yml#/components/schemas/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": "#/$defs/Point"
          }
        ]
      }
    }
  },
  "$defs": {
    "Address": {
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of address. There are three possible enumerated values: STREET_ADDRESS, PARCEL_COLLECT and COLLECTION_POINT."
        },
        "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."
        },
        "suburb": {
          "type": "string",
          "description": "An Australian suburb name."
        },
        "state": {
          "type": "string",
          "description": "An Australian state name."
        },
        "postcode": {
          "type": "integer",
          "description": "A four-digit Australian postcode.",
          "format": "int32"
        },
        "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."
        },
        "geo_location": {
          "type": [
            "object",
            "null"
          ],
          "description": "An object containing the precise coordinate location of an Australia Post outlet or facility.",
          "allOf": [
            {
              "$ref": "#/$defs/Location"
            }
          ]
        },
        "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"
        },
        "directions": {
          "type": "string",
          "description": "Indicates address instructions."
        }
      },
      "description": "An Address object contains full street address information for a specific Australia Post outlet or facility."
    },
    "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."
    },
    "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."
    },
    "Point": {
      "type": "object",
      "properties": {
        "address": {
          "description": "An object that contains full street address information for a specific Australia Post outlet or facility.",
          "allOf": [
            {
              "$ref": "#/$defs/Address"
            }
          ]
        },
        "secondary_addresses": {
          "description": "An object that contains full street address information for a specific Australia Post outlet or facility.",
          "allOf": [
            {
              "$ref": "#/$defs/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": "Indicates address instructions."
        },
        "fax_number": {
          "type": "string",
          "description": "An Australian fax number."
        },
        "geo_location": {
          "type": "object",
          "description": "An object containing the precise coordinate location of an Australia Post outlet or facility.",
          "allOf": [
            {
              "$ref": "#/$defs/Location"
            }
          ]
        },
        "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": "#/$defs/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."
    }
  }
}