Shopware icon

Shopware

Shopware

Actions778

Custom Field → Get Custom Field List

AI-generated

Overview

This node operation retrieves a list of custom fields from the Shopware platform. It is useful for scenarios where you need to fetch and manage custom field data, such as displaying custom fields in a user interface, syncing custom field data with other systems, or performing analytics on custom field usage.

Use Case Examples

  1. Fetching a paginated list of custom fields with a limit and page number to display in an admin dashboard.
  2. Querying custom fields with a specific SwagQL query to filter or sort the results.

Properties

Name Meaning
Limit Specifies the maximum number of custom field resources to be returned in a single page of results.
Page Specifies which page of the custom field list to return, useful for pagination.
Query An encoded SwagQL query in JSON format to filter or customize the retrieval of custom fields.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • customFields - Array of custom field objects returned from the Shopware API.
  • total - Total number of custom fields available matching the query.
  • page - Current page number of the returned custom field list.
  • limit - Maximum number of custom fields returned per page.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have sufficient permissions to access custom fields.
  • Verify that the query parameter is correctly encoded in SwagQL JSON format to avoid query errors.
  • Check network settings such as proxy and SSL options if requests fail or time out.
  • Common errors may include authentication failures, invalid query syntax, or exceeding API rate limits. Adjust request options or credentials accordingly.

Discussion