Custom attribute mutations

Custom attributes can extend the core data model in Adobe Commerce, allowing you to add additional attributes to entities without requiring code or database schema changes. Consider a situation where you want to specify a duns_number or industry_type information for a company. Custom attributes make this possible.

These custom attributes operate independently of the EAV (Entity-Attribute-Value) attributes, which are defined in the Admin. They do not apply to products, categories, or customers.

The following mutations allow you to set custom attributes:

• setCustomAttributesOnCart
• setCustomAttributesOnCartItem
• ​SaaS only setCustomAttributesOnCompany
• setCustomAttributesOnCreditMemo
• setCustomAttributesOnCreditMemoItem
• setCustomAttributesOnInvoice
• setCustomAttributesOnInvoiceItem
• ​SaaS only setCustomAttributesOnNegotiableQuote

The following entities now support custom attributes:

• Cart
• CartItemInterface
• ​SaaS only Company
• CreditMemo
• CreditMemoItem
• CreditMemoItemInterface
• CustomerOrder
• Invoice
• InvoiceItem
• InvoiceItemInterface
• ​SaaS only NegotiableQuote
• Order
• OrderItem
• OrderItemInterface
• Quote
• QuoteItem

Install custom attribute support

Prerequisites

• Adobe Commerce on cloud infrastructure or on-premises: 2.4.5+
• PHP 8.1+
• Magento Open Source is not supported.

Installation

To install custom attributes in Adobe Commerce:

1. Run the following command to install the modules:

   Copy
   composer require magento/out-of-process-custom-attributes=^0.2.0  --with-dependencies
   Copied to your clipboard
   composer require magento/out-of-process-custom-attributes=^0.2.0  --with-dependencies

2. Enable the new module:

   Copy
   bin/magento module:enable Magento_OutOfProcessCustomAttributes
   Copied to your clipboard
   bin/magento module:enable Magento_OutOfProcessCustomAttributes

3. For on-premises installations, run the following command to upgrade Adobe Commerce and clear the cache.

   Copy
   bin/magento setup:upgrade && bin/magento cache:clean
   Copied to your clipboard
   bin/magento setup:upgrade && bin/magento cache:clean

Last updated 6/10/2025

Was this helpful?

Yes

No