Shopware icon

Shopware

Shopware

Actions778

Customer Address → Search Customer Address

AI-generated

Overview

This node operation allows searching for customer addresses within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, making it useful for retrieving specific customer address data based on various criteria. Practical applications include fetching customer addresses for marketing campaigns, customer service, or data analysis.

Use Case Examples

  1. Retrieve the first page of customer addresses with a limit of 20 per page.
  2. Search customer addresses filtered by specific criteria such as city or postal code.
  3. Sort customer addresses by last name and include only selected fields in the response.

Properties

Name Meaning
Page The page number of the search results to retrieve.
Limit The number of items to return per page in the search results.
Filter A JSON list of filters to restrict the search results based on specific conditions.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list of filters applied after aggregations, not affecting them.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON list defining aggregations to perform on the search results.
Grouping A JSON list specifying groupings over certain fields in the search results.
Fields A JSON list specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but exact count), or next-pages (fast count for next pages).
Ids A JSON list of specific IDs to search for.
Includes A JSON object specifying fields to return for given entities, used to strip fields at the API level.
Request Options Settings for batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • data - The search results containing customer address records matching the query.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause errors. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the query significantly on large datasets.
  • SSL certificate validation errors can occur if 'Ignore SSL Issues' is not enabled when using self-signed certificates.

Links

Discussion