Shopware icon

Shopware

Shopware

Actions778

Product Search Config Field → Update Product Search Config Field

AI-generated

Overview

This node operation updates a Product Search Config Field in the Shopware system. It is useful for modifying the configuration of product search fields, such as changing the field's properties, ranking, tokenization, and searchability settings. For example, it can be used to update the search configuration to improve product search relevance or to adjust custom fields associated with product search.

Use Case Examples

  1. Updating the ranking and searchability of a product search config field to optimize search results.
  2. Modifying the tokenization setting of a product search config field to change how search terms are processed.

Properties

Name Meaning
Id Identifier for the product_search_config_field, used to specify which field to update.
_response Data format for response; controls the response format returned by the API.
searchConfigId Identifier for the search configuration to which the field belongs.
customFieldId Identifier for a custom field associated with the product search config field.
field The name of the field to be updated in the product search config.
tokenize Boolean flag indicating whether the field should be tokenized for search indexing.
searchable Boolean flag indicating whether the field is searchable.
ranking Numeric ranking value to influence the search priority of the field.
createdAt Timestamp indicating when the product search config field was created.
updatedAt Timestamp indicating when the product search config field was last updated.
searchConfig JSON object representing the search configuration details associated with the field.
customField JSON object representing the custom field details associated with the product search config field.

Output

JSON

  • id - The identifier of the updated product search config field.
  • searchConfigId - The identifier of the associated search configuration.
  • customFieldId - The identifier of the associated custom field.
  • field - The name of the updated field.
  • tokenize - Indicates if the field is tokenized.
  • searchable - Indicates if the field is searchable.
  • ranking - The ranking value of the field.
  • createdAt - Creation timestamp of the field.
  • updatedAt - Last update timestamp of the field.
  • searchConfig - The search configuration object associated with the field.
  • customField - The custom field object associated with the field.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Search Config Id, Field) are provided to avoid validation errors.
  • Check that the API credentials are correctly configured and have sufficient permissions to update product search config fields.
  • If the API returns errors related to JSON parsing, verify that the JSON input for 'searchConfig' and 'customField' is correctly formatted.
  • Timeouts or network errors can occur if the Shopware server is unreachable or slow; adjust timeout settings or check network connectivity.

Discussion