Field reference
All fields Product Studio can show, edit, check, import and export. The key is used in export headers
([key] or [key@language]) and in the API.
Changes: S set, E empty, A/R/W add, remove, replace (lists), F find and replace, C copy from another language, I inherit from the main product. Translatable fields are edited per language.
Product (read only)
| Key | Field | Notes |
|---|---|---|
productNumber | Product number | Identifies the product in exports and imports. |
createdAt | Created | |
updatedAt | Last changed | |
mediaCount | Images | Number of images; variants without own images count the main product's. |
cover | Image | Thumbnail of the cover image; variants without own cover show the main product's. |
Texts (translatable)
| Key | Field | Changes | Max. length |
|---|---|---|---|
name | Name | S E F C I | 255 |
description | Description (HTML) | S E F C I | |
metaTitle | Meta title | S E F C I | 255 |
metaDescription | Meta description | S E F C I | 255 |
keywords | Keywords | S E F C I | |
packUnit | Packaging unit | S E F C I | 255 |
packUnitPlural | Packaging unit (plural) | S E F C I | 255 |
customSearchKeywords | Search keywords | A R W E C I | 255 per keyword |
The name of a main product can't be emptied in the default language. Search keywords are a list: in a cell, an
export or an import they are separated by | (drill | cordless); duplicates are removed.
General
| Key | Field | Changes | Values |
|---|---|---|---|
active | Active | S I | yes/no |
manufacturer | Manufacturer | S E I | name or ID |
manufacturerNumber | Manufacturer number | S E F I | text, 255 |
ean | EAN / GTIN | S E F I | text, 255 |
markAsTopseller | Promoted | S I | yes/no |
releaseDate | Release date | S E I | date |
tags | Tags | A R W E I | names or IDs, separated by ` |
guaranteeMonths | Guarantee (months) | S E I | whole number; where Shopware validates it, a half-year value from 30 to 600 |
guaranteeConfirmed | Guarantee confirmed | S I | yes/no |
ratingAverage | Rating | read only | average product rating |
The guarantee fields exist from Shopware 6.7.x on; on older versions they are not offered.
Categories and channels
| Key | Field | Changes | Values |
|---|---|---|---|
categories | Categories | A R W E I | names or IDs, separated by ` |
visibilities | Sales channels | A R W | names or IDs; added with visibility "Everywhere" |
Shipping and packaging
| Key | Field | Changes | Values |
|---|---|---|---|
weight | Weight (kg) | S E I | number |
width, height, length | Width, height, length (mm) | S E I | number |
purchaseUnit | Selling unit | S E I | number |
referenceUnit | Basic unit | S E I | number |
unit | Scale unit | S E I | name or ID |
minPurchase | Minimum order quantity | S E I | whole number |
maxPurchase | Maximum order quantity | S E I | whole number |
purchaseSteps | Purchase steps | S E I | whole number |
shippingFree | Free shipping | S I | yes/no |
deliveryTime | Delivery time | S E I | name or ID |
Prices
| Key | Field | Changes | Values |
|---|---|---|---|
price | Price (gross) | S I | number, default currency; required on main products |
priceNet | Price (net) | S I | number, default currency; required on main products |
listPrice, listPriceNet | List price (gross, net) | S E | number, default currency |
purchasePrice, purchasePriceNet | Purchase price (gross, net) | S E I | number, default currency |
regulationPrice | Lowest price (30 days) | S E | number, gross, default currency |
price.<iso> | Price (CHF, USD, ...) | S E | number, gross, one field per other currency (price.chf) |
listPrice.<iso> | List price (CHF, USD, ...) | S E | number, gross |
advancedPrices | Advanced prices | read only in the sheet | all tiers of the product, see below |
Gross and net
A price is stored with both sides. When a price is linked (the default), changing one side calculates the other with the tax rate, like the administration does; the review shows that other side as well (muted), so a revert puts back both exactly. An unlinked price keeps its other side.
Variants
Variants inherit the whole price of their main product: all currencies, list price and lowest price at once. List prices, lowest prices and currency prices need an own price on the variant first. The purchase price is inherited as a whole too.
Other currencies
Empty means "no explicit price": Shopware converts the default price with the currency
factor. Emptying price.<iso> removes the explicit price (and its list price) for that currency. A list price in a
currency needs the price in that currency.
Advanced prices
Advanced prices (advancedPrices, one value per product with all tiers, per rule and quantity range) are shown in the
sheet and exported as readable text (Standard: 1–9 €10.00; 10+ €9.00), but can't be edited in a cell, a bulk
action or an import; the pricing feature changes them. Only changed tiers are rewritten, unchanged tiers keep their
rows.
Stock
| Key | Field | Changes | Values |
|---|---|---|---|
stock | Stock | S | whole number; never inherited |
availableStock | Available stock | read only | stock minus open orders, maintained by Shopware |
sales | Sales | read only | maintained by Shopware |
isCloseout | Clearance sale | S I | yes/no |
restockTime | Restock time (days) | S E I | whole number |
SEO and layout
| Key | Field | Changes | Values |
|---|---|---|---|
cmsPage | Layout | S E I | name or ID of a product page layout |
mainCategory.<sales channel id> | Main category (channel) | S E I | name or ID of a category; one field per sales channel |
seoUrl.<sales channel id> | SEO URL (channel) | read only | canonical product URL in the channel's default language |
A variant with its own main category in one channel no longer inherits the main categories of the other channels (Shopware inherits them as a whole).
Properties
One field per property group, with the key property.<group id> and the group name as label. Values are option names in any
language, or IDs, separated by |. Changes: A R W E I. On import, missing option names can be created in the group.
Custom fields
One field per active product custom field, with the key customField.<technical name> and the custom field label as
label.
Custom fields are translatable on products, like in the administration.
| Type | Changes | Values |
|---|---|---|
| Text, HTML | S E F C I | text |
| Number, yes/no, date, single select | S E C I | as the type |
| Multi-select | A R W E C I | option values or labels, separated by ` |
| Entity (single) | S E C I | name or ID (see below) |
| Entity (multiple) | A R W E C I | names or IDs, separated by ` |
Entity custom fields are supported for products, categories, manufacturers, property options, tags, sales channels, units, delivery times, layouts, rules, customer groups and dynamic product groups. JSON custom fields and entity custom fields of other entities are not offered.
Translations of custom fields
Text and HTML custom fields can be checked for missing and outdated translations like the product texts: choose them under "Custom fields to check" in the plugin configuration. They then appear as extra columns on the Languages tab and in the translation filters.
Not supported
Product creation and deletion, variant generation, media upload and order, cross-selling, editing SEO URLs, tax rate, product type and the downloads of digital products. Use the standard product page for these.