Shopware icon

Shopware

Shopware

Actions778

Custom Entity → Get Custom Entity List

AI-generated

Overview

This node operation retrieves a list of custom entities from the Shopware platform. It is useful for scenarios where you need to fetch paginated data of custom entities, such as displaying a list of custom records or processing them in batches. For example, you might use this to get a list of custom product attributes or user-defined data entries.

Use Case Examples

  1. Fetch the first 50 custom entities to display in a dashboard.
  2. Retrieve a specific page of custom entities for batch processing or analysis.

Properties

Name Meaning
Limit Maximum number of custom entities to return in one page.
Page The page number of the custom entity list to retrieve.
Query Encoded SwagQL query in JSON format to filter or customize the data retrieval.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • customEntities - Array of custom entity objects returned from the API.
  • pagination
    • page - Current page number of the returned list.
    • limit - Maximum number of entities returned per page.
    • total - Total number of custom entities available.

Dependencies

  • Shopware API credentials (API key or token)

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have sufficient permissions to access custom entities.
  • 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.
  • Common error messages may include authentication failures, invalid query syntax in the 'query' parameter, or timeout errors if the server does not respond in time.

Discussion