Shopware icon

Shopware

Shopware

Actions778

Order Address → Search Order Address

AI-generated

Overview

This node operation allows searching for order addresses within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific order address data efficiently. This is useful for scenarios such as extracting customer shipping or billing addresses for order management, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of order addresses with a limit of 20 items per page.
  2. Search order addresses filtered by a specific country or postal code.
  3. Sort order addresses by last name and return only selected fields like street and city.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON array specifying aggregations to perform on the search results.
Grouping JSON array defining groupings over certain fields in the search results.
Fields JSON array 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 accurate), or next-pages (fast for next page).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to return for given entities, used to control returned data at the API level.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • data - The array of order address objects returned from the search query.
  • total - The total number of order addresses matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is well-formed.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode can slow down the response time significantly on large datasets.
  • SSL certificate validation errors can occur if the server uses self-signed or invalid certificates; use the 'Ignore SSL Issues' option to bypass.
  • Proxy misconfiguration can prevent the node from connecting to the Shopware API.

Links

Discussion