Inheritance diagram for AddressRepositoryInterface:
Public Member Functions | |
| save (\Magento\Customer\Api\Data\AddressInterface $address) | |
| getById ($addressId) | |
| getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria) | |
| delete (\Magento\Customer\Api\Data\AddressInterface $address) | |
| deleteById ($addressId) | |
Detailed Description
Customer address CRUD interface. @api
- Since
- 100.0.2
Definition at line 14 of file AddressRepositoryInterface.php.
Member Function Documentation
◆ delete()
| delete | ( | \Magento\Customer\Api\Data\AddressInterface | $address | ) |
Delete customer address.
- Parameters
-
\Magento\Customer\Api\Data\AddressInterface $address
- Returns
- bool true on success
- Exceptions
-
◆ deleteById()
| deleteById | ( | $addressId | ) |
Delete customer address by ID.
- Parameters
-
int $addressId
- Returns
- bool true on success
- Exceptions
-
Implemented in AddressRepository.
◆ getById()
| getById | ( | $addressId | ) |
Retrieve customer address.
- Parameters
-
int $addressId
- Returns
- \Magento\Customer\Api\Data\AddressInterface
- Exceptions
-
Implemented in AddressRepository.
◆ getList()
| getList | ( | \Magento\Framework\Api\SearchCriteriaInterface | $searchCriteria | ) |
Retrieve customers addresses matching the specified criteria.
- Parameters
-
\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
- Returns
- \Magento\Customer\Api\Data\AddressSearchResultsInterface
- Exceptions
-
◆ save()
| save | ( | \Magento\Customer\Api\Data\AddressInterface | $address | ) |
Save customer address.
- Parameters
-
\Magento\Customer\Api\Data\AddressInterface $address
- Returns
- \Magento\Customer\Api\Data\AddressInterface
- Exceptions
-
The documentation for this interface was generated from the following file:
- vendor/magento/module-customer/Api/AddressRepositoryInterface.php