Skip to content
  1. Extras
  2. MiniShop3
  3. Manager interface
  4. Utilities
  5. Product fields

Utilities: Product fields ​

Utilities → Product fields

Field layout on the Data tab of the product card.

Cookbook

Sections, hiding fields, and the link to extra fields: Product fields cookbook. End-to-end example: Wholesale price.

Purpose ​

The tool controls the layout of fields on the Data tab:

  • visibility and order
  • groups by section
  • labels and widget xtypes

A new column in ms3_product_data is created in Extra fields. After you create the field, a row appears here on its own.

Interface ​

Sections ​

The left panel lists sections. Drag them to sort.

Fields ​

The right panel lists fields of the selected section.

In the row:

  • Field name (key)
  • Label
  • Widget type (xtype)
  • Visibility

Section management ​

Creating a section ​

  1. Click Add section
  2. Fill the form:
FieldDescriptionRequired
Section keyUnique identifier (Latin letters)Yes
Lexicon keyKey for the translated titleNo
TitleDisplay nameNo
HiddenThe section is hidden on the product cardNo

Lexicon

If a lexicon key is set, the title comes from the localization files. The interface is translated into several languages.

Editing a section ​

Click the edit icon to the right of the title, or double-click the section.

Deleting a section ​

Caution

When you delete a section, its fields move to No section. The fields themselves stay.

Field management ​

Editing a field ​

Click a field. The edit dialog opens.

Available parameters:

ParameterDescription
Title (label)Display name of the field
PlaceholderHint inside the input
DescriptionHint under the field
SectionWhich section the field belongs to
Widget type (xtype)Only while creating the field. The edit dialog locks this control
VisibilityWhether the field shows on the card
WidthGrid columns: 3, 4, 6, 8, 12

Widget types (xtype) ​

TypeDescription
textfieldSingle-line text
numberfieldNumber
textareaMultiline text
xcheckboxCheckbox
ms3-combo-vendorVendor picker
ms3-combo-autocompleteAutocomplete from a list
ms3-combo-optionsPick from product options

Moving fields ​

You move fields like this:

  • Inside a section, drag them up or down
  • Between sections, change the section in the edit dialog

Default sections ​

Defaults (seed product_data):

KeyTitleSeed fields
mainMain dataarticle, weight, color, size, vendor_id, made_in
pricingPrices and stockprice, old_price, stock
seoSEOempty section. You add the fields
additionalAdditionaltags, new, favorite, popular

Saving changes ​

  • Dragging saves automatically
  • When you edit a field or a section, click Save
  • Reload the page to see the change on the product card

API endpoints ​

Get field configuration ​

http
GET /api/mgr/config/page-fields/product_data

Response:

json
{
  "success": true,
  "data": {
    "fields": [
      {
        "name": "article",
        "label": "SKU",
        "xtype": "textfield",
        "section": 1,
        "visible": true,
        "sort_order": 0
      }
    ]
  }
}

Get sections ​

http
GET /api/mgr/config/sections/product_data

Save field configuration ​

http
PUT /api/mgr/config/page-fields/product_data

Write permission: mssetting_save. A GET is available to any manager session without mssetting_save.

Request body is a fields array (not one field):

json
{
  "fields": [
    {
      "name": "article",
      "label": "Product SKU",
      "section": 1,
      "visible": true,
      "sort_order": 0
    }
  ]
}

Save sections ​

The UI adds a new section locally, then saves the whole list:

http
PUT /api/mgr/config/sections/product_data
json
{
  "sections": [
    {
      "section_key": "custom",
      "lexicon_key": "ms3_section_custom",
      "label": "Additional",
      "hidden": false,
      "sort_order": 100
    }
  ]
}

Delete a section ​

http
DELETE /api/mgr/config/sections/product_data/{section_key}

Base sections cannot be deleted. There is no POST /config/sections/... in 1.13.x.

Configuration examples ​

Hide fields you do not need ​

If color and size are options, turn off visibility for color and size.

Create an "SEO" section ​

The seo section is already in the seed. If you deleted it, add it again (key seo). Document tab fields (longtitle, description) are not part of product_data. Their visibility is ms3_product_main_fields. Into the empty SEO section you move your own fields from main / additional, or extra fields.