Shopware icon

Shopware

Shopware

Actions778

Category → Update Category

AI-generated

Overview

This node operation updates an existing category in the Shopware system. It allows users to modify various attributes of a category such as its name, parent category, media, products, tags, SEO URLs, and sales channel assignments. This operation is useful for managing and organizing product categories dynamically within an e-commerce platform, ensuring that category information is current and accurately reflects the product catalog structure.

Use Case Examples

  1. Updating the name and description of a category to reflect a new marketing campaign.
  2. Changing the parent category of a category to reorganize the category hierarchy.
  3. Adding or updating media associated with a category to enhance its visual presentation on the storefront.
  4. Modifying SEO URLs and metadata to improve search engine optimization for category pages.

Properties

Name Meaning
Id Identifier for the category, required to specify which category to update.
Response Data format for response. Empty if none is provided.
Version Id Version identifier for the category.
Parent Id Identifier of the parent category.
Parent Version Id Version identifier for the parent category.
After Category Id Identifier of the category after which this category should be placed.
After Category Version Id Version identifier for the after category.
Media Id Identifier for media associated with the category.
Display Nested Products Boolean flag to display nested products within the category.
Auto Increment Auto increment number for the category.
Breadcrumb Breadcrumb navigation data for the category.
Level Level of the category in the hierarchy.
Path Path string representing the category's location in the hierarchy.
Child Count Number of child categories.
Type Type of the category.
Product Assignment Type Type of product assignment for the category.
Visible Boolean flag indicating if the category is visible.
Active Boolean flag indicating if the category is active.
Cms Page Id Switched Runtime field, cannot be used as part of the criteria.
Visible Child Count Runtime field, cannot be used as part of the criteria.
Name Name of the category, required.
Custom Fields Custom fields data in JSON format.
Slot Config Slot configuration data in JSON format.
Link Type Type of link associated with the category.
Internal Link Internal link URL.
External Link External link URL.
Link New Tab Boolean flag to open link in a new tab.
Description Description of the category.
Meta Title Meta title for SEO.
Meta Description Meta description for SEO.
Keywords SEO keywords.
Cms Page Id Identifier for the CMS page associated with the category.
Cms Page Version Id Version identifier for the CMS page.
Product Stream Id Identifier for the product stream.
Custom Entity Type Id Identifier for a custom entity type.
Created At Creation timestamp.
Updated At Update timestamp.
Translated Translated data in JSON format.
Parent Parent category data in JSON format.
Children Child categories data in JSON format.
Media Media data in JSON format.
Products Products data in JSON format.
Nested Products Nested products data in JSON format.
Tags Tags data in JSON format.
Cms Page CMS page data in JSON format.
Product Stream Product stream data in JSON format.
Navigation Sales Channels Navigation sales channels data in JSON format.
Footer Sales Channels Footer sales channels data in JSON format.
Service Sales Channels Service sales channels data in JSON format.
Main Categories Main categories data in JSON format.
Seo Urls SEO URLs data in JSON format.

Output

JSON

  • id - Identifier of the updated category
  • name - Name of the updated category
  • parentId - Identifier of the parent category
  • mediaId - Identifier of associated media
  • active - Indicates if the category is active
  • visible - Indicates if the category is visible
  • description - Description of the category
  • metaTitle - Meta title for SEO
  • metaDescription - Meta description for SEO
  • keywords - SEO keywords
  • createdAt - Creation timestamp
  • updatedAt - Update timestamp
  • customFields - Custom fields data
  • children - Child categories data
  • products - Products data
  • tags - Tags data
  • cmsPage - CMS page data
  • seoUrls - SEO URLs data
  • navigationSalesChannels - Navigation sales channels data
  • footerSalesChannels - Footer sales channels data
  • serviceSalesChannels - Service sales channels data
  • mainCategories - Main categories data
  • productStream - Product stream data
  • nestedProducts - Nested products data

Troubleshooting

  • Ensure the 'Id' and 'Name' fields are provided as they are required for the update operation.
  • Verify that JSON fields such as 'breadcrumb', 'customFields', 'slotConfig', 'parent', 'children', 'media', 'products', 'nestedProducts', 'tags', 'cmsPage', 'productStream', 'navigationSalesChannels', 'footerSalesChannels', 'serviceSalesChannels', 'mainCategories', and 'seoUrls' contain valid JSON data to avoid parsing errors.
  • Check API credentials and endpoint URL to ensure proper authentication and connectivity with the Shopware API.
  • If the update fails, review the error message for details on missing or invalid fields and correct them accordingly.

Discussion