Shopware icon

Shopware

Shopware

Actions778

User Access Key → Search User Access Key

AI-generated

Overview

This node operation allows searching for User Access Keys within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and other advanced search parameters. This is useful for scenarios where you need to retrieve specific user access keys based on various criteria, such as filtering by attributes, sorting results, or limiting the number of results per page.

Use Case Examples

  1. Retrieve a paginated list of user access keys with a limit of 10 per page.
  2. Search user access keys filtered by specific attributes using JSON filters.
  3. Sort user access keys by creation date in descending order.

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 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 associations to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying 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 determine how the total number of hits is calculated: none (disabled), exact (slow but exact), or next-pages (fast for next pages only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing API-level field stripping.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing the user access keys matching the query parameters.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, aggregations, grouping, fields, ids, or includes properties can cause errors. Ensure JSON is correctly formatted.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Network or authentication issues with the Shopware API can cause request failures. Verify credentials and network connectivity.

Links

Discussion