Shopware icon

Shopware

Shopware

Actions778

Number Range → Search Number Range

AI-generated

Overview

This node performs a search operation on the 'Number Range' resource within the Shopware platform. It allows users to query number ranges with various parameters such as pagination (page, limit), filtering, sorting, and grouping. This is useful for retrieving specific subsets of number ranges based on complex search criteria, which can be applied in scenarios like inventory management, order numbering, or any system that uses number ranges for categorization or identification.

Use Case Examples

  1. Search for number ranges with specific filters and sorting to display paginated results in a dashboard.
  2. Retrieve number ranges with specific fields and aggregations for reporting purposes.

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 fields to group the search results by.
Fields JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total count of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next pages only).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Collection of additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing the number ranges matching the query parameters.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Common issues may include invalid JSON format in filter, sort, or other JSON input fields, causing request failures.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Misconfigured request options like proxy or SSL settings can cause connectivity issues.
  • Errors related to authentication usually indicate missing or invalid API credentials.

Links

Discussion