Shopware icon

Shopware

Shopware

Actions778

Customer Group → Create Customer Group

AI-generated

Overview

This node operation creates a new Customer Group in the Shopware system. It allows users to specify various attributes of the customer group such as its ID, name, display settings, registration options, custom fields, associated customers, sales channels, and registration sales channels. This operation is useful for managing customer segmentation and access control in an e-commerce platform, enabling tailored marketing, pricing, and registration workflows.

Use Case Examples

  1. Creating a customer group with a specific ID and name to segment customers for targeted promotions.
  2. Setting registration options to control how customers can register under this group.
  3. Associating specific customers and sales channels to the customer group for customized access and pricing.

Properties

Name Meaning
Response Data format for the response, either basic or detailed information about the created customer group.
Id Unique identifier for the customer group.
Name Name of the customer group.
Display Gross Boolean flag to indicate whether prices should be displayed gross (including tax).
Custom Fields Custom JSON fields for additional data related to the customer group.
Registration Active Boolean flag to indicate if registration for this customer group is active.
Registration Title Title text shown during registration for this customer group.
Registration Introduction Introduction text shown during registration for this customer group.
Registration Only Company Registration Boolean flag to restrict registration to company registrations only.
Registration Seo Meta Description SEO meta description text for the registration page of this customer group.
Created At Timestamp string indicating when the customer group was created.
Updated At Timestamp string indicating when the customer group was last updated.
Translated JSON object containing translated fields for the customer group.
Customers JSON array of customer objects associated with this customer group.
Sales Channels JSON array of sales channel objects associated with this customer group.
Registration Sales Channels JSON array of sales channel objects used specifically for registration purposes for this customer group.

Output

JSON

  • id - Unique identifier of the created customer group.
  • name - Name of the created customer group.
  • displayGross - Indicates if prices are displayed gross.
  • registrationActive - Indicates if registration is active for the group.
  • registrationTitle - Registration title text.
  • registrationIntroduction - Registration introduction text.
  • registrationOnlyCompanyRegistration - Indicates if only company registrations are allowed.
  • registrationSeoMetaDescription - SEO meta description for registration.
  • createdAt - Creation timestamp.
  • updatedAt - Last update timestamp.
  • translated - Translated fields JSON object.
  • customers - Associated customers JSON array.
  • salesChannels - Associated sales channels JSON array.
  • registrationSalesChannels - Registration-specific sales channels JSON array.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure that the required fields 'Id' and 'Name' are provided, as they are mandatory for creating a customer group.
  • Verify that JSON fields such as 'Custom Fields', 'Customers', 'Sales Channels', and 'Registration Sales Channels' are correctly formatted JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure successful connection to the Shopware Admin API.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings.
  • Timeouts can be adjusted in the request options if the server response is slow.

Discussion