REST customers/search endpoint does not allow searching of child address fields

[toby11]

Preconditions and environment

2.4.2-p2

Fresh installation with sample data.

Steps to reproduce

When performing a search using the customers/search end point like this

searching by email which is in the main customer object works fine

https://www.xxx.com/rest/V1/customers/search?searchCriteria[filterGroups][0][filters][0][field]=email&searchCriteria[filterGroups][0][filters][0][value]=test@test.com&searchCriteria[filterGroups][0][filters][0][condition_type]=like

however it seems its not possible to search by telephone number (or any other address field) which is contained in the addresses child object

I have tried addresses[telephone] as the field name :

https://www.xxx.com/rest/V1/customers/search?searchCriteria[filterGroups][0][filters][0][field]=addresses[telephone]&searchCriteria[filterGroups][0][filters][0][value]=1234123123&searchCriteria[filterGroups][0][filters][0][condition_type]=like

but I get the following response

The "%1" attribute name is invalid. Reset the name and try again.

I have also tried addressess.telephone as well but same result

Expected result

a list of customer records matching the address field I searched for.

Actual result

The "%1" attribute name is invalid. Reset the name and try again.

error is returned.

Additional information

I feel the severity is high as its makes the search endpoint pretty useless.

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @toby11. Thank you for your report.
To speed up processing of this issue, make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[m2-assistant]

Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-November]

Verified the issue on Magento 2.4-develop branch and the issue is reproducible. Unable to search using nested child elements with query parameters

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.magento.com/browse/AC-3490 is successfully created for this GitHub issue.

[m2-assistant]

✅ Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[engcom-November]

Hi @toby11 ,
Verified the issue again on Magento 2.4-develop branch and found that we can only search top-level attributes using filter_groups array as per Magento devdocs and can search for nested/child objects using "fields" parameter
Example to retrieve telephone number of customer address is: GET request: http://xyz.coml/rest/V1/customers/3/?fields=addresses[telephone]


Kindly recheck the issue again on Magento 2.4-develop branch and provide reference documents/proof that supports "filter_groups" parameter be used for nested objects.
Thank you.