Customer Module

Api\AccountDelegationInterface

Interface

This interface defines a contract for delegating customer account creation actions from external modules. Developers use this to redirect users to a c...

Api\AccountManagementInterface

Interface

This interface defines the contract for managing customer account operations in Magento 2. Developers use this to perform operations like creating cus...

Api\AddressMetadataInterface

Interface

This interface defines constants for working with customer address attribute metadata in Magento 2. Developers use it to retrieve information about cu...

Api\AddressMetadataManagementInterface

Interface

This interface defines the contract for managing metadata of customer address attributes in Magento 2. Developers use this interface to work with cust...

Api\CustomerGroupConfigInterface

Interface

This interface defines operations for managing system-wide customer group configuration in Magento 2. Developers use this to programmatically set the...

Api\CustomerManagementInterface

Interface

This interface defines a contract for managing customer-related operations in Magento 2. Developers use this interface to retrieve the total count of...

Api\CustomerMetadataInterface

Interface

This interface defines constants and contracts for retrieving metadata about customer entity attributes in Magento 2. Developers use this when they ne...

Api\CustomerMetadataManagementInterface

Interface

This interface defines the contract for managing customer entity metadata in Magento 2. Developers use this to work with customer attribute metadata o...

Api\CustomerNameGenerationInterface

Interface

This interface defines a contract for generating a customer's full name from their customer data object. Developers use this when they need to display...

Api\Data\AddressInterface

Interface

This interface defines the data contract for customer addresses in Magento 2. Developers use it to retrieve and manipulate customer address informatio...

Api\Data\AddressSearchResultsInterface

Interface

This interface defines the contract for customer address search results in Magento 2's API layer. Developers use this when implementing or consuming s...

Api\Data\AttributeMetadataInterface

Interface

This interface defines the contract for customer attribute metadata, providing methods to get and set properties like frontend input type, validation...

Api\Data\CustomerInterface

Interface

This interface defines the contract for customer data objects used in Magento 2's API layer. Developers use this when working with customer informatio...

Api\Data\CustomerSearchResultsInterface

Interface

This interface defines the contract for customer search results returned by repository search operations. Developers use this when implementing or con...

Api\Data\GroupExcludedWebsiteInterface

Interface

This interface defines the data structure for managing customer group exclusions at the website level in multi-store Magento installations. Developers...

Api\Data\GroupInterface

Interface

This interface defines the contract for customer group data objects in Magento 2. Developers use it to get and set customer group properties like ID,...

Api\Data\GroupSearchResultsInterface

Interface

This interface defines the contract for search results when querying customer groups in Magento 2. Developers use this interface to handle collections...

Api\Data\OptionInterface

Interface

This interface defines the structure for customer attribute options, such as dropdown or multi-select values. It supports hierarchical options through...

Api\Data\RegionInterface

Interface

This interface defines the contract for customer address region data in Magento 2. Developers use it when working with customer addresses to access or...

Api\Data\ValidationResultsInterface

Interface

This interface defines the structure for validation result objects in Magento 2's customer module. Developers use it to check if customer data is vali...

Api\Data\ValidationRuleInterface

Interface

This interface defines a validation rule data structure used in Magento 2's customer module. Developers use this to define and retrieve validation rul...

Api\GroupManagementInterface

Interface

This interface defines methods for managing and retrieving customer groups in Magento 2. Developers use it to access default groups, check if a group...

Api\MetadataInterface

Interface

This interface defines methods for retrieving metadata about customer and customer address attributes in Magento 2. Developers use this to get informa...

Api\MetadataManagementInterface

Interface

This interface defines methods for managing customer attribute metadata in admin grids. Developers use it to determine whether specific customer attri...

Api\SessionCleanerInterface

Interface

This interface defines a contract for clearing customer session data. Developers would implement this interface when they need to destroy all active s...

Model\Address\AddressModelInterface

Interface

This interface defines methods for handling multi-line street addresses in Magento 2. Developers implement this interface when creating address models...

Model\Address\CustomAttributeListInterface

Interface

This interface defines a contract for retrieving custom attributes that have been added to customer addresses. Developers implement this interface whe...

Model\Address\ValidatorInterface

Interface

This interface defines a contract for validating customer address instances in Magento 2. Developers implement this interface to create custom address...

Model\AuthenticationInterface

Interface

This interface defines the contract for customer authentication operations in Magento 2. Developers use this to authenticate customers with passwords,...

Model\Customer\Source\GroupSourceInterface

Interface

This interface defines a contract for classes that provide customer group options as a data source. Developers implement this interface when creating...

Model\EmailNotificationInterface

Interface

This interface defines the contract for sending email notifications to customers in Magento 2. Developers implement this interface to handle customer-...

Model\Group\RetrieverInterface

Interface

This interface defines a contract for retrieving the current customer's group ID from the session. Developers use implementations of this interface wh...