PHPackages                             voyage/silverstripe-nzpost-addressfinder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. voyage/silverstripe-nzpost-addressfinder

AbandonedArchivedSilverstripe-module[Utility & Helpers](/categories/utility)

voyage/silverstripe-nzpost-addressfinder
========================================

Add address autocomplete field using NZPost API

1.0.0(8y ago)0648PHPPHP >=5.4

Since Dec 18Pushed 8y ago1 watchersCompare

[ Source](https://github.com/vyg/silverstripe-nzpost-addressfinder)[ Packagist](https://packagist.org/packages/voyage/silverstripe-nzpost-addressfinder)[ RSS](/packages/voyage-silverstripe-nzpost-addressfinder/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (3)Versions (2)Used By (0)

NZ Post Address Finder
======================

[](#nz-post-address-finder)

Address finder module for NZ Post API.

> This is currently using the 1.0-client version of the API. All requests require your client\_id and client\_secret and does not use the Oauth implementation as in 1.0.

Getting started
---------------

[](#getting-started)

Sign up with NZ Post for API access. Grab your client\_id and client\_secret and add to your `config.yml` file

```
NZPOSTAPI:
  client_id: "1234567890"
  client_secret: "1234567890"
```

This module comes with both the `AddressFinderField` for use in your own Forms as well as the `EditableAddressFinderField` for use in Userforms.

### Form Field

[](#form-field)

Add the AddressFinderField in your Form like below. Make sure you add `setFieldMap` and include the fields you want to map the returned results to. The key should always be your form field ID and the value will be the NZ Post field (these values can be found below or in the NZ Post API documentation).

```
$field = AddressFinderField::create('AddressFinderField', 'Search for an address')
  ->setFieldMap([
    "FormField_AddressLine1" => "AddressLine1",
    "FormField_AddressLine2" => "AddressLine2",
    "FormField_City" => "CityTown",
    "FormField_Postcode" => "Postcode"
  ]);
```

### Userforms Field

[](#userforms-field)

This module comes with a field for use in Userforms. The `EditableAddressFinderField` adds a mapping tab to the edit view of the field. Where you can add multiple mappings.

Each mapping requires the user forms field ID or name as well as a corresponding NZ Post value to grab.

#### Content Editors

[](#content-editors)

When using the Userforms Field, content editors need to manually select the fields they want mapped via the CMS.

On the Field editing view, there is a tab for Mappings. From here a content editor can add a new field mapping and match another Userform Field ID/Name to an NZ Post Field ID.

The name for a userform field can be found in the Fields main tab.

#### Field Mappings

[](#field-mappings)

The following fields are available from NZ Post for mapping. The values shown are just examples based on the returned response.

```
"DPID": 3111226,
"AddressLine1": "7 Waterloo Quay",
"AddressLine2": "Pipitea",
"AddressLine3": "Wellington 6011",
"AddressLine4": null,
"AddressLine5": null,
"Postcode": "6011",
"SourceDesc": "Postal\\Physical - Not Delivered",
"Deliverable": "N",
"Physical": "Y",
"UnitType": null,
"UnitValue": null,
"Floor": null,
"StreetNumber": 7,
"StreetAlpha": null,
"RoadName": "Waterloo",
"RoadTypeName": "Quay",
"RoadSuffixName": null,
"Suburb": "Pipitea",
"RuralDelivery": null,
"Lobby": null,
"CityTown": "Wellington",
"MailTown": null,
"BoxBagNumber": null,
"BoxBagType": null
```

Contributing
------------

[](#contributing)

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

Acknowledgements
----------------

[](#acknowledgements)

[Silverstripe Google Address Field](https://github.com/sunnysideup/silverstripe-google_address_field) - Inspiration for mapping field values

License
-------

[](#license)

TODO
----

[](#todo)

- Add unit tests
- Add JS testing
- Make SS4 compatible
- Finish setting up Oauth

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3067d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9c3ec171dfd075c033b1b76f8f2483be768501318941baaf638358c964815240?d=identicon)[voyage](/maintainers/voyage)

---

Top Contributors

[![ohararyan](https://avatars.githubusercontent.com/u/1509309?v=4)](https://github.com/ohararyan "ohararyan (3 commits)")

---

Tags

addresssilverstripenzpost

### Embed Badge

![Health badge](/badges/voyage-silverstripe-nzpost-addressfinder/health.svg)

```
[![Health](https://phpackages.com/badges/voyage-silverstripe-nzpost-addressfinder/health.svg)](https://phpackages.com/packages/voyage-silverstripe-nzpost-addressfinder)
```

###  Alternatives

[silverstripe/environmentcheck

Provides an API for building environment tests

35503.8k13](/packages/silverstripe-environmentcheck)[symbiote/silverstripe-addressable

SilverStripe addressable and geocoding module

2985.1k7](/packages/symbiote-silverstripe-addressable)[jonom/silverstripe-share-care

Social media sharing previews and customisation for Silverstripe

2932.7k1](/packages/jonom-silverstripe-share-care)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)