netresearch/postdirekt-autocomplete

Deutsche Post Direkt Autocomplete Integration for Shopware6

1.5.0 2024-07-03 13:44 UTC

Requires

• php: ^8.2
• deutschepost/sdk-api-autocomplete-authentication: ^1.2.0
• php-http/curl-client: ^2.2.0
• shopware/core: ~6.6.0
• shopware/storefront: ~6.6.0
• slim/psr7: ^1.4.0

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.4
• fig/log-test: ^1.1
• phpunit/phpunit: *

MIT

• Netresearch DTT GmbH

README

This extension adds autocompletion functionality for customer addresses to your shop frontend (checkout and customer account) using the Deutsche Post Direkt Autocomplete API 2.0.

Requirements

• Shopware 6.6.0 or newer
• PHP >= 8.2
• Contract with Deutsche Post Direkt GmbH for using the Autocomplete 2.0 API

Installation

From Community Store

You have bought the plugin in the Shopware community store. You manage your plugins from within your shop.

Please follow the corresponding documentation.

From Community Store via Composer (recommended)

You have bought the plugin in the Shopware community store and want to manage your shop's plugins and dependencies with composer.

Follow the Shopware Instruction Video to set up your shop for using composer.

composer require store.shopware.com/nrlejpostdirektautocomplete
bin/console plugin:refresh
bin/console plugin:install --activate --clearCache NRLEJPostDirektAutocomplete

From Packagist

You are fine with having to install dependencies of the plugin yourself.

Assuming, you are using the Flex-Template, run the following commands from your shop's root directory:

composer require netresearch/postdirekt-autocomplete
(cd vendor/netresearch/postdirekt-autocomplete/src/Resources/app/storefront && npm install)
composer dump
bin/console plugin:refresh
bin/console plugin:install --activate --clearCache NRLEJPostDirektAutocomplete
bin/build-js.sh

From GitHub

You are fine with having to install dependencies of the plugin yourself. You want to extend or adapt the extension to your own needs.

Run the following command from your shop's root directory:

git clone [e-mail]:netresearch/deutschepost-module-autocomplete-sw6 custom/plugins/NRLEJPostDirektAutocomplete

Then, continue as described in From Packagist.

Configuration

• Navigate to Administration > Settings > System > Plugins
• Select '…' in the "Deutsche Post Direkt Autocomplete" row and select "Config"
• Check "Active"
• Enter your credentials in the "API User" and "API Password" fields
• Check "Active" in "House number hint" if the hint should be active
• Navigate to Administration > Settings > Snippets to maintain postdirekt.autocomplete.housenumber_hint snippets

Author

Netresearch DTT GmbH

License

See LICENSE.md.