Shopware icon

Shopware

Shopware

Actions778

Category → Get Category List

AI-generated

Overview

This node operation retrieves a list of categories from the Shopware API. It supports pagination and filtering through query parameters, allowing users to specify the maximum number of categories to return per page, the page number to fetch, and an encoded SwagQL query for advanced filtering. This operation is useful for scenarios where you need to fetch and process category data from a Shopware store, such as syncing categories with another system, displaying categories in a custom application, or performing analytics on category data.

Use Case Examples

  1. Fetch the first 50 categories by setting Limit to 50 and Page to 1.
  2. Retrieve categories matching specific criteria by providing a SwagQL query in the Query parameter.

Properties

Name Meaning
Limit Max amount of category resources to be returned in a page.
Page The page number of the category list to be returned.
Query Encoded SwagQL query in JSON format to filter the category list.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • categories - Array of category objects returned from the Shopware API.

Dependencies

  • Shopware API credentials (API key or token)

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access category data.
  • Verify that the limit and page parameters are set to valid numbers to avoid request errors.
  • If using a custom SwagQL query, ensure it is properly encoded and valid according to Shopware's query language.
  • Check network settings if using proxy or SSL options to avoid connection issues.

Discussion