Shopware icon

Shopware

Shopware

Actions778

Document Type → Search Document Type

AI-generated

Overview

This node operation allows searching for document types within the Shopware system. It supports pagination, filtering, sorting, and various advanced search query options to refine the search results. This is useful for scenarios where you need to retrieve specific document types based on criteria such as filters, sorting order, or specific fields, for example, when integrating Shopware data into workflows or automating document management.

Use Case Examples

  1. Retrieve the first page of document types with a limit of 10 items per page.
  2. Search document types with specific filters applied to narrow down results.
  3. Sort document types by a certain field and include only specific fields in the response.

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per result page.
Filter A list of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations in the search results.
Associations Associations to include in the search query.
Aggregations Aggregations to include in the search query.
Grouping Groupings to perform over certain fields in the search results.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query. Options include none (disabled), exact (slow but exact count), and next-pages (fast count for next page).
Ids List of specific document type IDs to search for.
Includes Specify fields to be returned for given entities, with entity names as keys and field lists as values.

Output

JSON

  • data - The array of document type objects returned from the search.
  • total - The total number of document types matching the search criteria.
  • aggregations - Aggregation results based on the search query.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access document types.
  • Verify that JSON inputs for filters, sorting, and other advanced options are correctly formatted to avoid parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If using total count modes, be aware that 'exact' mode can be slow and may impact performance.

Links

Discussion