Shopware icon

Shopware

Shopware

Actions778

Custom Entity → Create Custom Entity

AI-generated

Overview

This node operation allows users to create a Custom Entity in the Shopware system. It is useful for scenarios where users need to define and add new custom data entities with specific fields and configurations to their Shopware environment. For example, a user might create a custom entity to manage additional product attributes or customer data that are not covered by default entities.

Use Case Examples

  1. Creating a custom entity with a unique ID, name, and a set of fields defining its structure.
  2. Setting flags and awareness options to control the behavior of the custom entity within the Shopware system.

Properties

Name Meaning
Response Specifies the data format for the response, either basic or detailed.
Id The unique identifier for the custom entity.
Name The name of the custom entity.
Fields A JSON object defining the fields of the custom entity.
Flags A JSON object specifying flags related to the custom entity.
App Id The application ID associated with the custom entity.
Plugin Id The plugin ID associated with the custom entity.
Cms Aware Boolean indicating if the entity is CMS aware, a runtime field not used in criteria.
Store Api Aware Boolean indicating if the entity is aware of the store API, a runtime field not used in criteria.
Custom Fields Aware Boolean indicating if the entity supports custom fields.
Label Property The label property of the custom entity.
Deleted At Timestamp indicating when the entity was deleted.
Created At Timestamp indicating when the entity was created.
Updated At Timestamp indicating when the entity was last updated.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • id - The unique identifier of the created custom entity.
  • name - The name of the created custom entity.
  • fields - The fields defined in the created custom entity.
  • flags - Flags associated with the created custom entity.
  • appId - The application ID linked to the custom entity.
  • pluginId - The plugin ID linked to the custom entity.
  • cmsAware - Indicates if the entity is CMS aware.
  • storeApiAware - Indicates if the entity is aware of the store API.
  • customFieldsAware - Indicates if the entity supports custom fields.
  • labelProperty - The label property of the custom entity.
  • deletedAt - Timestamp of when the entity was deleted.
  • createdAt - Timestamp of when the entity was created.
  • updatedAt - Timestamp of when the entity was last updated.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Name, Fields) are provided to avoid validation errors.
  • Check the JSON format for the Fields and Flags properties to prevent parsing errors.
  • Verify API credentials and endpoint URL to avoid authentication or connection issues.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in Request Options.

Discussion