Shopware icon

Shopware

Shopware

Actions778

System Operations → Index

AI-generated

Overview

This node performs the 'Index' operation within the 'System Operations' resource of the Shopware API. It is designed to handle system-level indexing tasks, allowing users to specify which indexers or updaters to skip during the operation. This can be useful for managing and optimizing system indexing processes in Shopware, such as reindexing product data or other system entities while excluding certain indexers to improve performance or avoid conflicts.

Use Case Examples

  1. A user wants to reindex the product catalog but skip certain indexers that are not relevant to the current update.
  2. A system administrator needs to trigger system indexing but exclude specific updaters to prevent unnecessary processing.

Properties

Name Meaning
Skip An array of indexers or updaters to be skipped during the indexing operation. This allows selective exclusion of certain indexers from the process.
Request Options Settings to control the request behavior, including batching of requests, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • result - The outcome of the indexing operation, typically indicating success or failure and any relevant details returned by the Shopware API.

Dependencies

  • Shopware API credentials (API key or token)

Troubleshooting

  • Ensure the 'skip' property is correctly formatted as a JSON array; invalid JSON will cause errors.
  • Check that the Shopware API credentials are valid and have sufficient permissions for system operations.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Verify proxy settings if used, to ensure requests are properly routed.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

Discussion