Rest resources
Permissions list

The Address decoupled module is an API expose for the Address module.

The module consists of a service that connects to the address services for building an address format via API, validating any address, listing all the available countries, and saving an address to any entity.

The module has several API endpoints that work with the address logic. As a note, there is no support yet for the zone or country field types, but only for the address because it's a common usage in most of the cases.

Features

There are 5 rest resources for:

  • Listing all the countries or those filtered by the country codes
  • Getting the country data like subdivisions, fields (required, optional), postal code pattern, etc. to build the address format form via decoupled
  • The address validation
  • Address save for a particular entity into a particular field
  • Get the commerce store supported countries information

Post-Installation

Once the module gets installed make sure to configure the user permissions for the corresponding user roles to access the new REST resources from this module. The permissions can be found under the RESTful Web Services. Here are the permissions:

  • Access GET on Address decoupled - Countries list resource
  • Access GET on Address decoupled - Country data resource
  • Access GET on Address decoupled - Validate address resource
  • Access POST on Address decoupled - Save address resource
  • Access GET on Address decoupled - Store Supported Countries resource

Additional Requirements

The module requires the module Address and the core module Rest.

Community Documentation

The usage documentation can be found here.

Supporting organizations: 
Maintainer

Project information

Releases