Shopware icon

Shopware

Shopware

Actions778

Custom Field Set → Update Custom Field Set

AI-generated

Overview

This node operation updates a Custom Field Set in the Shopware system. It allows users to modify various attributes of a Custom Field Set such as its name, configuration, active status, global flag, position, associated app ID, timestamps, and related custom fields, relations, products, and app details. This operation is useful for managing and customizing metadata fields in Shopware to tailor the data structure to specific business needs.

Use Case Examples

  1. Updating the name and configuration of a Custom Field Set to reflect new business requirements.
  2. Activating or deactivating a Custom Field Set based on its usage status.
  3. Modifying the position or global flag of a Custom Field Set to change its visibility or order in the system.

Properties

Name Meaning
Id Identifier for the custom_field_set, used to specify which Custom Field Set to update.
Response Data format for the response; can be left empty if no specific format is required.
Name The new name for the Custom Field Set.
Config JSON configuration object for the Custom Field Set, allowing detailed customization.
Active Boolean flag indicating whether the Custom Field Set is active.
Global Boolean flag indicating whether the Custom Field Set is global.
Position Numeric value indicating the position or order of the Custom Field Set.
App Id Identifier for the associated app, if any.
Created At Timestamp indicating when the Custom Field Set was created.
Updated At Timestamp indicating when the Custom Field Set was last updated.
Custom Fields JSON array defining the custom fields associated with the Custom Field Set.
Relations JSON array defining relations associated with the Custom Field Set.
Products JSON array defining products associated with the Custom Field Set.
App JSON object containing app-related details associated with the Custom Field Set.

Output

JSON

  • id - Identifier of the updated Custom Field Set.
  • name - Name of the updated Custom Field Set.
  • config - Configuration details of the updated Custom Field Set.
  • active - Active status of the updated Custom Field Set.
  • global - Global flag status of the updated Custom Field Set.
  • position - Position of the updated Custom Field Set.
  • appId - App ID associated with the updated Custom Field Set.
  • createdAt - Creation timestamp of the updated Custom Field Set.
  • updatedAt - Last update timestamp of the updated Custom Field Set.
  • customFields - Custom fields data of the updated Custom Field Set.
  • relations - Relations data of the updated Custom Field Set.
  • products - Products data of the updated Custom Field Set.
  • app - App details of the updated Custom Field Set.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the identifier of the Custom Field Set to update; missing or incorrect Id will cause the update to fail.
  • Verify that the JSON properties (config, customFields, relations, products, app) are correctly formatted JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure successful authentication and connection to the Shopware Admin API.
  • If the update does not reflect, confirm that the user has sufficient permissions to modify Custom Field Sets in Shopware.

Discussion