Shopware icon

Shopware

Shopware

Actions778

Custom Field Set → Get Custom Field Set List

AI-generated

Overview

This node operation retrieves a list of Custom Field Sets from the Shopware platform. It is useful for scenarios where you need to fetch and manage metadata or custom fields associated with entities in Shopware, such as products or customers. For example, you might use this operation to display available custom field sets in a user interface or to process them in an automation workflow.

Use Case Examples

  1. Fetch a paginated list of custom field sets to display in an admin dashboard.
  2. Retrieve custom field sets with specific query filters for data analysis or integration.

Properties

Name Meaning
Limit Maximum number of custom field set resources to be returned in a single page of results.
Page The page number of results to return, used for pagination.
Query Encoded SwagQL query in JSON format to filter or customize the returned custom field sets.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • customFieldSets - Array of custom field set objects returned from the Shopware API.
  • pagination
    • page - Current page number of the returned results.
    • limit - Maximum number of items per page as requested.
    • total - Total number of custom field sets available.

Dependencies

  • Shopware API with appropriate admin credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permissions to access custom field sets.
  • Check that the 'limit' and 'page' parameters are set to valid numbers to avoid request errors.
  • If using a proxy or ignoring SSL issues, verify network and security settings to prevent connection failures.
  • Timeout errors may occur if the server is slow or unresponsive; consider increasing the timeout setting.

Discussion