Commerce Category

Internal ID: commercecategory

Supports Custom Fields

Fields

Internal ID Type nlapiSubmitField Label Required Help
addtohead richtext false Addition to <head> false The addition to head field lets you specify code such as HTML, CSS, or JavaScript to include between the <head></head> tags on this category page.
catalog select false Catalog true Select the catalog to which this category will be assigned.
created date false Creation Date/Time false
description textarea false Description false Specifies the description for the record.
displayinsite select false Display in Web Site false Specifies if the category is available to visitors on your site.
enddate datetime End Date false This identifies the end date and time for the record. When this date is passed, the content is no longer be visible the site. If there is no end date, the content does not expire. This relates to Content Visibility topic in the Help. Enter the date and time in the same format as specified in your preferences.
externalid text false ExternalId false
isinactive checkbox false Inactive false Mark a category as inactive when you want to prevent it from displaying on the website and also prevent any other activity from occurring with that category. For example, when a category is inactive, it cannot be assigned as a subcategory of another category. You cannot mark a category as inactive if it has subcategories assigned to it. When a category as marked as inactive, it is omitted, by default, from the Commerce Categories list. To include inactive categories in the list, select the Show Inactives box on the categories list page.
lastmodified date false Last Modified false
lastmodifiedby select false Modified By false
metadescription text false Meta Description false The description you enter here is an important SEO consideration. It is normally the description that is included on search results pages.
metakeywords text false Meta Keywords false Meta keywords for the page.
name text false Name true Specify the name for this record.
origbinactive checkbox false false
pagebanner select false Page Banner false Image file in the file cabinet that can be displayed as the banner on a category page on an SuiteCommerce site. The page template file must be configured to display the banner image.
pageheading text false Heading false This heading displays at the top of the category page. The page template must be configured to display the heading.
pagetitle text false Page Title false Enter a title for the page. This value populates the <title> element for an category page.
primaryparent select false Primary Parent false If you are creating a subcategory, select the primary parent category to which this subcategory should be assigned. The new category is assigned as a subcategory for the parent category specified here. Leave this field empty if you do not want to assign a primary parent category. When a subcategory is assigned to multiple parent categories, you create a scenario where duplicate content can be accessed through multiple URLs. For SEO best practice, the primary parent flag is used to build the canonical link tag which tells webcrawlers that this is the preferred URL for accessing the content.
sequencenumber integer false Sequence Number false This number controls the order of how categories are displayed in SMT. If you leave this blank, sequence numbers are assigned automatically based on any manual ordering of categories in SMT.
sitemappriority select false Sitemap Priority false This value populates the <priority></priority> element in an XML sitemap. Valid values for the priority are 0.0 to 1.0. If no priority is set in the sitemap then the default priority of 0.5 is used. These priorities let you rank the importance of the pages on your site as they relate to each other. Search results pages may consider this ranking when presenting multiple pages from your site and order the pages based on the priority.
startdate datetime Start Date false This identifies the start date and time for the record you are viewing. If this is a future date, the content does not display until that date. This related to the Content Visibility topic in the help. Enter the date and time in the same format as specified in your preferences.
thumbnail select false Thumbnail Image false File in the file cabinet to display as the thumbnail image for this category.
urlfragment text false URL Fragment true The URL Fragment specifies the section of the URL used to navigate to the category page. The fragment does not include slashes.
version integer false Version false

Sublists

customersegments - Customer Segment

Internal ID Type Label Required Help
customersegment select Customer Segment false

items - Items

Internal ID Type Label Required Help
item select Items false
primarycategory checkbox Primary Category false
sequencenumber integer Sequence Number false

subcategories - Subcategories

Internal ID Type Label Required Help
addtoheadoverride richtext Addition to <head> Override false
descriptionoverride text Description Override false
displayinsiteoverride select Display in Web Site Override false
metadescriptionoverride text Meta Description Override false
metakeywordsoverride text Meta Keywords Override false
nameoverride text Name Override false
pagebanneroverride select Page Banner Override false
pageheadingoverride text Heading Override false
pagetitleoverride text Title Override false
sequencenumber integer Sequence Number false
sitemappriorityoverride select Sitemap Priority Override false
subcategory select Subcategory true
thumbnailoverride select Thumbnail Image Override false
urlfragmentoverride text URL Fragment Override false

tags - Commerce Category Tag

Internal ID Type Label Required Help
name text Name false

urls - URLs

Internal ID Type Label Required Help
fullurl text Full Url false
id integer Internal ID false
idpath text ID Path false
isprimary checkbox Primary false
nestlevel integer Level false

Search Filters

Internal ID Type Label
addtohead text Add to Head
catalog select Catalog
created date Creation Date/Time
description textarea Description
displayinsite checkbox Display in Web Site
enddate datetime End Date
externalid select External ID
externalidstring text External ID (Text)
fullurl text Full URL
idpath text ID Path
internalid select Internal ID
internalidnumber integer Internal ID (Number)
isinactive checkbox Inactive
isprimaryurl checkbox Is Primary URL
item select Item
itemcategory select Item Category ID
itemdescription textarea Item Description
lastmodified date Last Modified
lastmodifiedby select Modified By
metadescription text Meta Description
metakeywords text Meta Keywords
name text Name
nestlevel integer Nest Level
pageheading text Page Heading
pagetitle text Page Title
primarycategory checkbox Primary Category of Item
primaryparent select Primary Parent
sequencenumber integer Sequence Number
site select Site
sitemappriority float Sitemap Priority
startdate datetime Start Date
subcatdisplayinsiteoverride checkbox Subcategory Display In Site Override
subcatid select Subcategory ID
subcatparent select Subcategory Parent ID
urlfragment text URL
version integer Version

Search Columns

Internal ID Type Label
addtohead text Add to Head
catalog select Catalog
created date Creation Date/Time
description textarea Description
displayinsite checkbox Display in Web Site
enddate datetime End Date
externalid select External ID
fullurl text Full URL
idpath text ID Path
internalid select Internal ID
isinactive checkbox Inactive
isprimaryurl checkbox Is Primary URL
itemdescription textarea Item Description
itemid integer Item ID
itemsequencenumber integer Item Sequence Number
lastmodified date Last Modified
lastmodifiedby select Modified By
metadescription text Meta Description
metakeywords text Meta Tag HTML
name text Name
nestlevel integer Nest Level
pagebanner image Category Page Banner
pagebannerurl text Category Page Banner URL
pageheading text Page Heading
pagetitle text Page Title
primarycategory checkbox Primary Category of Item
primaryparent select Primary Parent
sequencenumber integer Sequence Number
sitemappriority float Sitemap Priority
startdate datetime Start Date
subcataddtoheadoverride text Subcategory Add to Head Override
subcatdescoverride text Subcategory Description Override
subcatdisplayinsiteoverride checkbox Subcategory Display In Site Override
subcatid integer Subcategory ID
subcatmetadescoverride text Subcategory Meta Description Override
subcatmetakeywordsoverride text Subcategory Meta Keywords Override
subcatnameoverride text Subcategory Name Override
subcatpagebanneroverride select Subcategory Page Banner Override
subcatpagebannerurloverride text Subcategory Page Banner URL Override
subcatpageheadingoverride text Subcategory Page Heading Override
subcatpagetitleoverride text Subcategory Page Title Override
subcatparent integer Subcategory Parent ID
subcatsequencenumber integer Subcategory Sequence Number
subcatthumbnailoverride select Subcategory Thumbnail Override
subcatthumbnailurloverride text Subcategory Thumbnail URL Override
subcaturlfragmentoverride text Subcategory URL Fragment Override
thumbnail image Category Thumbnail
thumbnailurl text Category Thumbnail URL
urlcommcat integer URL Category
urlcommcatassoc integer URL Category Association
urlfragment text URL
version integer Version