Shopware icon

Shopware

Shopware

Actions778

Custom Field → Create Custom Field

AI-generated

Overview

This node operation allows users to create a custom field in the Shopware system. It is useful for scenarios where users need to extend the data model with additional fields tailored to their specific business requirements. For example, a user might create a custom field to store extra product attributes or customer information that is not available by default.

Use Case Examples

  1. Creating a custom field to capture additional product details such as 'manufacturer warranty period'.
  2. Adding a custom field to customer profiles to track loyalty program membership status.

Properties

Name Meaning
Response Specifies the data format for the response, either 'Basic' or 'Detail'.
Id The unique identifier for the custom field to be created.
Name The name of the custom field.
Type The data type of the custom field.
Config JSON configuration object for the custom field.
Active Boolean flag indicating whether the custom field is active.
Custom Field Set Id Identifier for the custom field set to which this custom field belongs.
Allow Customer Write Boolean flag indicating if customers are allowed to write to this custom field.
Allow Cart Expose Boolean flag indicating if the custom field is exposed in the cart.
Created At Timestamp string indicating when the custom field was created.
Updated At Timestamp string indicating when the custom field was last updated.
Custom Field Set JSON object representing the custom field set details.
Product Search Config Fields JSON array representing product search configuration fields related to the custom field.

Output

JSON

  • id - The unique identifier of the created custom field.
  • name - The name of the created custom field.
  • type - The data type of the created custom field.
  • config - Configuration details of the created custom field.
  • active - Indicates if the custom field is active.
  • customFieldSetId - The ID of the custom field set the field belongs to.
  • allowCustomerWrite - Indicates if customers can write to this field.
  • allowCartExpose - Indicates if the field is exposed in the cart.
  • createdAt - Creation timestamp of the custom field.
  • updatedAt - Last update timestamp of the custom field.
  • customFieldSet - Details of the custom field set.
  • productSearchConfigFields - Product search configuration fields related to the custom field.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Name, Type) are provided to avoid validation errors.
  • Check API credentials and base URL configuration if authentication errors occur.
  • Verify JSON format for 'Config', 'Custom Field Set', and 'Product Search Config Fields' to prevent parsing errors.

Discussion