{
  "opencollection": "1.0.0",
  "info": {
    "name": "Delivery Partner Endpoints API",
    "version": "1.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "AUTH-KEY",
      "value": "{{AUTH-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Endpoints",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Sends the delivery event to Australia Post",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/api/v1/event",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Accepts Tracking Events which have resulted in a notification being sent by a delivery partner and which AP are to be informed of."
        },
        {
          "info": {
            "name": "getPointsByPostcode",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/postcode/:postcode",
            "params": [
              {
                "name": "postcode",
                "value": "",
                "type": "path",
                "description": "A four-digit Australian postcode."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              },
              {
                "name": "types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getPointsByWorkCenterID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/workcentres/:work_centre_id",
            "params": [
              {
                "name": "work_centre_id",
                "value": "",
                "type": "path",
                "description": "See the endpoint description above."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              },
              {
                "name": "types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getPointsByDeliveryPointId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/deliverypoints/:delivery_point_id",
            "params": [
              {
                "name": "delivery_point_id",
                "value": "",
                "type": "path",
                "description": "See the endpoint description above."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              },
              {
                "name": "types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getPointsByLocationCode",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/:location_code",
            "params": [
              {
                "name": "location_code",
                "value": "",
                "type": "path",
                "description": "See the endpoint description above."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getPointsByType",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/type/:points_type",
            "params": [
              {
                "name": "points_type",
                "value": "",
                "type": "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."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "This endpoint returns a list of all points associated with a specific Australia Post point_type"
        },
        {
          "info": {
            "name": "getPointsByGeoCoordinates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/points/geo/:longitude/:latitude",
            "params": [
              {
                "name": "longitude",
                "value": "",
                "type": "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."
              },
              {
                "name": "latitude",
                "value": "",
                "type": "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."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              },
              {
                "name": "usage_types",
                "value": "",
                "type": "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."
              },
              {
                "name": "radius",
                "value": "",
                "type": "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."
              },
              {
                "name": "services",
                "value": "",
                "type": "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return. The default value is 5."
              },
              {
                "name": "types",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getServices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/services",
            "params": [
              {
                "name": "pc",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "getServicesByServiceCodes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://digitalapi.auspost.com.au/delivery-partner/services/:service_codes",
            "params": [
              {
                "name": "service_codes",
                "value": "",
                "type": "path",
                "description": "A comma-delimited list of service codes by which to filter the returned list of matching locations."
              },
              {
                "name": "pc",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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."
        }
      ]
    }
  ],
  "bundled": true
}