Shopware icon

Shopware

Shopware

Actions778

Product Search Config Field → Create Product Search Config Field

AI-generated

Overview

This node operation creates a new Product Search Config Field in the Shopware system. It is useful for configuring how product search behaves by defining fields that can be searched, tokenized, ranked, and associated with custom fields or search configurations. For example, it can be used to add a new searchable field to improve product search relevance in an e-commerce platform.

Use Case Examples

  1. Creating a new search config field with specific ranking and tokenization settings to enhance product search results.
  2. Associating a custom field with a product search configuration to tailor search behavior to business needs.

Properties

Name Meaning
Response Specifies the data format for the response, either basic or detailed.
Id The unique identifier for the product search config field to be created.
Search Config Id The identifier of the search configuration to which this field belongs.
Custom Field Id Optional identifier for a custom field associated with this search config field.
Field The name of the field to be used in the product search configuration.
Tokenize Boolean flag indicating whether the field should be tokenized for search indexing.
Searchable Boolean flag indicating whether the field is searchable.
Ranking Numeric value representing the ranking priority of the field in search results.
Created At Timestamp indicating when the search config field was created.
Updated At Timestamp indicating when the search config field was last updated.
Search Config JSON object representing the detailed search configuration associated with this field.
Custom Field JSON object representing the detailed custom field associated with this search config field.

Output

JSON

  • id - The unique identifier of the created product search config field.
  • searchConfigId - The identifier of the associated search configuration.
  • customFieldId - The identifier of the associated custom field, if any.
  • field - The name of the field in the product search configuration.
  • tokenize - Indicates if the field is tokenized for search indexing.
  • searchable - Indicates if the field is searchable.
  • ranking - The ranking priority of the field in search results.
  • createdAt - Timestamp of when the field was created.
  • updatedAt - Timestamp of the last update to the field.
  • searchConfig - The detailed search configuration object associated with the field.
  • customField - The detailed 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.
  • If the API returns authentication errors, verify that the Shopware Admin API credentials are correctly configured.
  • For JSON fields (Search Config, Custom Field), ensure the JSON is well-formed to prevent parsing errors.

Discussion