Commerce Custom Fields

This topic applies to

Applies to

SuiteCommerce Web Stores | Elbrus | Kilimanjaro

SuiteCommerce lets you access core and custom field values through the Commerce API, Items API, and SuiteScript. You can add custom fields to your SuiteCommerce site in two ways:

  • Using the SuiteCommerce Custom Fields extension

  • Customizing your theme or Core SCA templates

When you install and activate the SuiteCommerce Custom Field extension, you add a subtab to your SuiteCommerce configuration that lets you specify which custom fields you want to add, the location, and the order in which the fields appear.

Important

SuiteCommerce extensions are only available if they are provisioned and set up in your account. For more information, see NetSuite Extensions.


The SuiteCommerce Custom Fields extension supports the following kind of custom field records:

  • Custom Transaction Body Fields – adds custom transaction fields to the Checkout. You can also include section headers and indicate whether the field is required.

Alternatively you can configure your site and customize template files as part of a theme to render information or ask for information stored in these fields on your web store’s Shopping, Checkout, and My Account pages.

Note

If you are using SuiteCommerce Aconcagua and later, you implement custom fields as part of a theme. If you are using SuiteCommerce Advanced, you implement custom fields by customizing the core SCA source code.


SuiteCommerce supports the following kinds of custom field records:

  • Custom Item Fields – adds custom item field data associated with an item. These fields apply to the Product Details Page (PDP), Checkout, and My Account.

  • Custom Transaction Body Fields – adds custom transaction fields to the body of a web store transaction (order as a whole). You can also include some field metadata (such as the field label or item options). These fields apply to Checkout and My Account.

  • Custom Transaction Line Fields – adds a custom transaction field to the column of a transaction record (across multiple transaction lines in an order). These fields apply to the PDP, Cart, Checkout, and My Account.

  • Custom Transaction Item Options – adds a custom transaction field that applies to a transaction line (one line item within an order). These fields apply to the PDP, Cart, Checkout, and My Account.

Note

Site Builder extensions supports custom fields appearing in Checkout and My Account only.