Commerce Custom Fields

This topic applies to

Applies to

Commerce Web Stores

 

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

  • Create Custom Fields Using an Extension – When you install and activate the SuiteCommerce Custom Fields extension, you add a subtab to your SuiteCommerce Configuration record where you specify the custom fields you want to add, the location, and the order in which the fields appear.

    The SuiteCommerce Custom Fields extension lets you add fields to Checkout and Product Detail Pages of your website. Custom Checkout fields only support the custom transaction body field type.

  • Create Custom Fields by Customizing Templates – 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 Advanced Aconcagua or later, you implement custom fields as part of a theme or using an extension. If you are using SuiteCommerce Advanced Kilimanjaro or earlier, you implement custom fields by customizing the core SCA source code.


Commerce web stores support the following kinds of custom field records:

  • Custom Item Fields – add 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 – add 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 – add 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 – add 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 Reference implementations support custom fields appearing in Checkout and My Account only.