Shopware icon

Shopware

Shopware

Actions778

Product Export → Create Product Export

AI-generated

Overview

This node operation creates a new Product Export in the Shopware system. It is useful for automating the export of product data streams to various sales channels and storefronts, allowing users to define export parameters such as file format, encoding, sales channels, currency, and scheduling options. For example, a user can set up a product export to generate CSV files for a specific sales channel on a scheduled interval, including product variants and custom templates.

Use Case Examples

  1. Automate exporting product data to a storefront sales channel in CSV format.
  2. Schedule regular product exports with custom header, body, and footer templates.
  3. Create product exports with specific currency and sales channel domain settings.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the product export.
Product Stream Id Identifier for the product stream to export.
Storefront Sales Channel Id Identifier for the storefront sales channel.
Sales Channel Id Identifier for the sales channel.
Sales Channel Domain Id Identifier for the sales channel domain.
Currency Id Identifier for the currency used in the export.
File Name Name of the export file.
Access Key Access key for authentication or authorization.
Encoding File encoding format.
File Format Format of the export file (e.g., CSV, XML).
Include Variants Whether to include product variants in the export.
Generate By Cronjob Whether the export is generated by a scheduled cron job.
Generated At Timestamp when the export was generated.
Interval Interval in seconds or minutes for scheduled exports.
Header Template Template for the header section of the export file.
Body Template Template for the body section of the export file.
Footer Template Template for the footer section of the export file.
Paused Schedule Whether the export schedule is paused.
Is Running Whether the export process is currently running.
Created At Timestamp when the export was created.
Updated At Timestamp when the export was last updated.
Product Stream JSON object defining the product stream filters and related data.
Storefront Sales Channel JSON object defining the storefront sales channel details.
Sales Channel JSON object defining the sales channel details.
Sales Channel Domain JSON object defining the sales channel domain details.
Currency JSON object defining the currency details.

Output

JSON

  • id - Unique identifier of the created product export.
  • productStreamId - Identifier of the product stream associated with the export.
  • storefrontSalesChannelId - Identifier of the storefront sales channel.
  • salesChannelId - Identifier of the sales channel.
  • salesChannelDomainId - Identifier of the sales channel domain.
  • currencyId - Identifier of the currency used.
  • fileName - Name of the export file.
  • accessKey - Access key used for the export.
  • encoding - Encoding format of the export file.
  • fileFormat - Format of the export file.
  • includeVariants - Flag indicating if product variants are included.
  • generateByCronjob - Flag indicating if export is generated by a cron job.
  • generatedAt - Timestamp when the export was generated.
  • interval - Interval for scheduled exports.
  • headerTemplate - Template for the header of the export file.
  • bodyTemplate - Template for the body of the export file.
  • footerTemplate - Template for the footer of the export file.
  • pausedSchedule - Flag indicating if the schedule is paused.
  • isRunning - Flag indicating if the export process is running.
  • createdAt - Timestamp when the export was created.
  • updatedAt - Timestamp when the export was last updated.
  • productStream - Detailed JSON object of the product stream.
  • storefrontSalesChannel - Detailed JSON object of the storefront sales channel.
  • salesChannel - Detailed JSON object of the sales channel.
  • salesChannelDomain - Detailed JSON object of the sales channel domain.
  • currency - Detailed JSON object of the currency.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (marked as required) are provided to avoid validation errors.
  • Verify that the JSON fields (productStream, storefrontSalesChannel, salesChannel, salesChannelDomain, currency) are correctly formatted JSON strings before sending.
  • Check API credentials and base URL configuration to ensure successful authentication and connection to the Shopware Admin API.
  • If the export creation fails, review the API response for error messages related to invalid IDs or permissions.

Discussion