What is system-objecttype-extensions.xml?

This metadata file adds custom attributes to standard B2C Commerce objects — Product, Customer, Order, LineItemCtnr, and others. It is the most common SFCC metadata task: adding a "gift message" field to Product, a "loyalty tier" to Customer, or a "fraud score" to Order.

What attribute types are available?

string, text (multiline), int, double, boolean, date, datetime, email, html, image, password, enum-of-string, enum-of-int, set-of-string, and set-of-int. Enum and set types require value definitions. Image attributes store a reference to a content asset.

What is a site-specific attribute?

A site-specific attribute can have different values per storefront site. Non-site-specific attributes have a single value shared across all sites. Use site-specific for attributes that vary by locale or market (e.g. a promotional badge text), and shared for attributes that are global (e.g. a product compliance flag).

What are attribute groups?

Attribute groups control how custom attributes are displayed in Business Manager. Without a group, custom attributes appear in a default "Custom Attributes" section. Creating named groups (e.g. "Gifting Options", "SEO") organises the BM edit page and makes it easier for merchandisers to find the right field.

How do I import the generated XML?

Place the file at sites/site_template/meta/system-objecttype-extensions.xml inside a site archive, then import via Business Manager > Administration > Site Development > Site Import & Export. Alternatively use the SFCC CLI or the sfcc-import tool on this site to inspect the archive first.

System Object Attributes XML Builder

Build system-objecttype-extensions.xml for SFCC site archives. Add custom attributes to Product, Customer, Order, and other standard objects.

Object type

Custom attributes

Mandatory Searchable Site-specific
Mandatory Searchable Site-specific

Attribute groups

giftMessagepriorityLabel

Extension valid — XML ready

Generated XML

<?xml version="1.0" encoding="UTF-8"?>
<metadata xmlns="http://www.demandware.com/xml/impex/metadata/2006-10-31">
    <type-extension type-id="Product">
        <custom-attribute-definitions>
            <attribute-definition attribute-id="giftMessage">
                <display-name xml:lang="x-default">Gift Message</display-name>
                <type>string</type>
            </attribute-definition>
            <attribute-definition attribute-id="priorityLabel">
                <display-name xml:lang="x-default">Priority</display-name>
                <type>enum-of-int</type>
                <value-definitions>
                    <value-definition>
                        <display xml:lang="x-default">Low</display>
                        <value>1</value>
                    </value-definition>
                    <value-definition>
                        <display xml:lang="x-default">High</display>
                        <value>9</value>
                    </value-definition>
                </value-definitions>
            </attribute-definition>
        </custom-attribute-definitions>
        <group-definitions>
            <attribute-group group-id="gifting">
                <display-name xml:lang="x-default">Gifting Options</display-name>
                <attribute attribute-id="giftMessage"/>
                <attribute attribute-id="priorityLabel"/>
            </attribute-group>
        </group-definitions>
    </type-extension>
</metadata>

About System Attributes XML Builder

Generate system-objecttype-extensions.xml to add custom attributes to standard B2C Commerce objects. Choose the object type, define attributes with types and validation rules, organise them into Business Manager groups, and download the ready-to-import XML.

Pipeline

SFCC Site Import Analyzer — inspect the archive that contains this XML.
Permission Set Diff — compare permission sets after adding new fields.

Frequently asked

What is system-objecttype-extensions.xml?: This metadata file adds custom attributes to standard B2C Commerce objects — Product, Customer, Order, LineItemCtnr, and others. It is the most common SFCC metadata task: adding a "gift message" field to Product, a "loyalty tier" to Customer, or a "fraud score" to Order.
What attribute types are available?: string, text (multiline), int, double, boolean, date, datetime, email, html, image, password, enum-of-string, enum-of-int, set-of-string, and set-of-int. Enum and set types require value definitions. Image attributes store a reference to a content asset.
What is a site-specific attribute?: A site-specific attribute can have different values per storefront site. Non-site-specific attributes have a single value shared across all sites. Use site-specific for attributes that vary by locale or market (e.g. a promotional badge text), and shared for attributes that are global (e.g. a product compliance flag).
What are attribute groups?: Attribute groups control how custom attributes are displayed in Business Manager. Without a group, custom attributes appear in a default "Custom Attributes" section. Creating named groups (e.g. "Gifting Options", "SEO") organises the BM edit page and makes it easier for merchandisers to find the right field.
How do I import the generated XML?: Place the file at sites/site_template/meta/system-objecttype-extensions.xml inside a site archive, then import via Business Manager > Administration > Site Development > Site Import & Export. Alternatively use the SFCC CLI or the sfcc-import tool on this site to inspect the archive first.