Shopware icon

Shopware

Shopware

Actions778

Document Base Config → Search Document Base Config

AI-generated

Overview

This node operation allows searching within the Document Base Config resource in Shopware. It supports detailed search queries with pagination, filtering, sorting, and other advanced search options. This is useful for retrieving specific document base configurations based on various criteria, such as filtering by fields, sorting results, and controlling the number of results per page.

Use Case Examples

  1. Retrieve the first page of document base configurations with a limit of 10 items per page.
  2. Search document base configurations with specific filters applied to narrow down results.
  3. Sort document base configurations by a particular field and apply post-filters without affecting aggregations.

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 A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to control how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • data - The search results data containing the document base configurations matching the query.
  • total - The total number of matching results based on the search query.
  • aggregations - Aggregation results if any aggregations were specified in the search query.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the JSON inputs for filters, sort, post-filter, aggregations, grouping, fields, ids, and includes are correctly formatted JSON arrays or objects as expected by the API.
  • If the total count mode is set to 'exact', the query might be slow; consider using 'next-pages' or 'none' for better performance.
  • Check that the base URL and credentials for the Shopware Admin API are correctly configured to avoid authentication or connection errors.

Links

Discussion