Interchangeable terms for Australia Post Parcel Lockers

This page details about the interchangeable terms for parcel lockers during lookup or validation.

Configure Interchangeable Parcel Locker Terms

Terms for parcel locker can be configured using the file 'general_au.properties' available in $HARMONY_HOME/config/sub folder.

Default terms listed in the file are as follows:

Adding additional interchangeable terms as follows:

If a user is searching for a parcel locker address using the term 'Pcl Lkrs,' they will need to add this term to the properties file.

You can add or modify terms in this file according to your requirements to ensure that users can search for parcel locker addresses using various terms.

Sample to demonstrate the response of HRA similar-addresses using the new term.

API:

POST http://localhost:8080/HRAWeb/hra/rest/au/address/similar-addresses

Request: Input of 'PCL LKRS'

{
  "option": {
    "source": "AUPOST",
    "top": "2"
  },
  "payload": {
    "fullAddress": "strathfield pcl lkrs"
  }
}

Response: Shows that 'Pcl lkrs' is interchangeable with 'Parcel Lockers' during lookup

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "Aust Catholic Uni Strathfield Pcl Lkr, 25a Barker Rd, STRATHFIELD NSW 2135",
            "addressLine1": "25a Barker Rd",
            "addressLine2": "STRATHFIELD NSW 2135",
            "dpid": "98635762",
            "localityName": "STRATHFIELD",
            "postcode": "2135",
            "buildingName1": "Aust Catholic Uni Strathfield Pcl Lkr",
            "latitude": "-33.876703",
            "longitude": "151.078330",
            "id": "98635762_UPL",
            "attributes": {
                "address_line_1": "25a Barker Rd",
                "description": "Available 24x7",
                "id": "98635762_UPL",
                "name": "Aust Catholic Uni Strathfield Pcl Lkr",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Strathfield Parcel Lockers, Shop 1 19 Everton Road, STRATHFIELD NSW 2135",
            "addressLine1": "Shop 1 19 Everton Road",
            "addressLine2": "STRATHFIELD NSW 2135",
            "dpid": "76897456",
            "localityName": "STRATHFIELD",
            "postcode": "2135",
            "buildingName1": "Strathfield Parcel Lockers",
            "latitude": "-33.871547",
            "longitude": "151.095547",
            "id": "76897456_UPL",
            "attributes": {
                "address_line_1": "Shop 1 19 Everton Road",
                "description": "Available 24/7",
                "id": "76897456_UPL",
                "location_description": "Parcel Locker is located outside main entrance to Post Shop",
                "name": "Strathfield Parcel Lockers",
                "record_type": "upl",
                "type": "UPL"
            }
        }
    ]
}

Sample to demonstrate the response of AupostValidation PDP using the new term.

API:

POST http://localhost:8080/HarmonyWS/rest/parseCustomerData

Request: Input of 'PCL LKRS'

{
    "harmonyServiceConfig": {
        "role": "AupostValidationRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
            "address": {
                "value": "Strathfield pcl lkrs, Shop 1 19 Everton Road, STRATHFIELD NSW 2135"
            }
        }
    }
}

Response: Shows that 'Pcl lkrs' is interchangeable with 'Parcel Lockers' during validation

{
    "ciqPartyDocument": {
        "addresses": [
            {
                "state": "NSW",
                "streetName": "Everton",
                "streetNumber": "19",
                "flatNumber": "1",
                "placeMajorName": "Strathfield Parcel Lockers",
                "addressQuality": 9,
                "gml": {
                    "geocodedPosition": "151.095547 -33.871547"
                },
                "addressLines": [
                    "Strathfield Parcel Lockers, Shop 1 19 Everton Road, STRATHFIELD NSW 2135"
                ],
                "addressLine": "Strathfield Parcel Lockers, Shop 1 19 Everton Road, STRATHFIELD NSW 2135",
                "postCode": "2135",
                "postalID": "76897456",
                "area": "STRATHFIELD",
                "flatType": "Shop",
                "streetType": "Road",
                "addressMessage": "POINT",
                "extraAttributes": {
                    "AddressLine1": "Shop 1 19 Everton Road",
                    "Type": "UPL",
                    "Description": "Available 24/7",
                    "LocationDescription": "Parcel Locker is located outside main entrance to Post Shop",
                    "RecordType": "upl",
                    "AddressQuality": "9",
                    "PostalID": "76897456",
                    "Id": "76897456_UPL",
                    "AddressMessage": "POINT",
                    "MatchedRule": "address",
                    "Name": "Strathfield Parcel Lockers"
                }
            }
        ],
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}