Skip to main content

How do I configure custom fields for my documents?

Custom fields let you flexibly extend orders and products with individual information and display it directly in documents. This makes it easy to adapt order documents to industry-specific or internal company requirements. The possible use cases vary depending on the industry and customer. Here are some practical examples that show what's possible with custom fields:

  • Wine trade: vintage, grape variety, alcohol content, or quality seal

  • Coffee or specialty food trade: organic seal number, roast level, flavor profile

  • Electronics: serial or model variants, technical specifications

  • Fashion: material composition, care instructions

  • Fireworks: legal information on explosive content

  • B2B business: internal references, project numbers, cost centers, or agreements at the order level

  • Marketplace information such as the Amazon transaction ID

Unlike information recorded during unloading, custom fields let you record information that applies to all copies of a product, so it doesn't need to be entered manually for every order.

Creating custom fields

Custom fields are managed in sets. Under Settings → Content → Custom fields (Zusatzfelder) you'll find all existing sets. You can also add new custom fields to existing sets at a later time.

Below, we'll show you the basic steps for creating a new set. To do this, click Create set in the top right.

Here you can enter the following information:

  • Technical name – Every set needs a technical name for unique identification, which always starts with custom_. This name cannot be changed later.

  • Position – If you have multiple custom field sets per entity, you can control the display order using this value. The lower this value, the further to the front the set appears.

  • Label – The Label field corresponds to the name of the set as it will later be displayed in the entity. If the option Maintain in all administration languages (In allen Administrationssprachen pflegen) is enabled, you can maintain the name of the set in additional languages of your admin besides your default language.

  • Use for (Verwenden für) – Here you select the entities for which the custom field set should be available.

Then save your set.

Now you can create custom fields further down.

First, select a field type here. Depending on the type, you can define additional properties. For the Selection field (Auswahlfeld) type, for example, you'll find the option further down to define various options. Regardless of the field type chosen, you can assign the name in the Label field below.

The technical name is made up of custom, the name of the custom field set, and any name you choose for the field, each separated by underscores. This name also cannot be changed later. If you accidentally save your custom field without assigning a complete technical name, an error message will appear as soon as you try to fill in the field in an entity.

Once everything is filled in to your satisfaction, click Add to finish.

You can find more detailed information on configuring custom fields here in the Shopware documentation.

Filling in custom fields

You'll find custom fields in various places within the respective entities. Here's an overview:

  • Orders: Details tab → Custom fields (Zusatzfelder) section

  • Products: Specifications tab → Custom fields (Zusatzfelder) section

  • Batches (Chargen): Custom fields (Zusatzfelder) section

  • Supplier orders (Lieferantenbestellungen): Custom fields (Zusatzfelder) tab

  • Customers: General tab → Custom fields (Zusatzfelder) section

  • Warehouses (Lager): Overview tab → Custom fields (Zusatzfelder) section

  • Suppliers (Lieferanten): General tab → Custom fields (Zusatzfelder) section

  • Shipping methods (Versandarten): Custom fields (Zusatzfelder) section

If you haven't created any custom fields for the relevant entity yet, your view will look like this. The link takes you directly to creating custom fields.

Zusatzfelder .png

If custom fields are available, they are arranged in tabs by set:

Displaying custom fields in documents

Via the document configuration

For certain document types, you can select custom fields directly in the document configuration. These include cancellation invoice, delivery note, invoice, credit note, and picklist. There you'll find a section for products and orders, through which you can control where which custom fields should be displayed and in what order.

Zusatz 1.png

Product custom fields appear directly under the respective order line item, while custom fields of the order are summarized at the end of the document.

Dokument.png

Via the template file

If you want to display custom fields on other documents, such as the supplier order, or if you want to further customize the display, you can add the custom fields directly in the template file. You can find out how this works directly in the Shopware documentation.

Did this answer your question?