Introduction

This reference for developers is an excerpt of all common type codes.

This document uses the following conventions:

• UPPERCASE captions refer to table names in the Intershop database schema.
• Tables are listed in alphabetical order.
• The column name is the same as the attribute name if not mentioned otherwise.
• The referring persistent object name can be deduced from the table name + suffix PO - adjust the case as necessary if not mentioned otherwise.
• The data type is listed as it is defined in the model (edl) for the persistent object. The interface type may differ. If there is no persistent object for the table, the data type is listed like in the database.
• Sources that define type codes or describe them are listed, other documents are linked if they may be helpful.

Custom Attributes in separate *_AV tables

Data type for attribute type: int required  

Related Source:

• core/javasource/com/intershop/beehive/core/capi/domain/AttributeDefinitionConstants.java
• core/edl/com/intershop/beehive/core/capi/domain/AttributeValuePO.edl

ACCOUNT

Data type for attribute typeCode: int

Account/Owner TypeCodes are described as follows:

Numeric type codes can be used to distinguish different types of accounts for UI purposes

:for Affiliate:

Bonus point account is used only until 7.1, in higher versions a separate account object type (BonusPointAccountPO) is used instead.

ACCOUNTTRANSACTION

Data type for attribute typeCode: int readonly

Account Transaction TypeCodes (TransactionTypes) - Source: Pipeline comments:

for Affiliate Accounts:

for Bonus Point Accounts:

ALERT

Data type for attribute typeCode: int required

"type code handling is futile because of no typecode will be set"

There are no pre-defined type codes for alerts

Currently it is not used in the standard product

The alert handler class is at the moment more important

APPLICATIONTYPE

Data type for attribute applicationTypeCode: int searchable

This application type is not related to the application types that can be declared and wired via the component framework.

ATTRIBUTEGROUP

Data type for attribute TypeCode: int required

It is originally meant to have a way to distinguish between attribute groups for different objects.

The type code can be used to distinguish between several types of attribute groups, i.e., product and category attribute groups.

There are no pre-defined values

not used, default value is 0

related sources:

• bc_foundation/javasource/com/intershop/component/foundation/capi/attributegroup/AttributeGroup.java
• bc_foundation/edl/com/intershop/component/foundation/capi/attributegroup/AttributeGroup.edl
• pipeline code of ViewProductAttributeGroups_32

AUCTION

Data type for attribute typeCode: int

This attribute defines the type of the auction (i.e., one of English, Dutch, forward or reverse). The TypeCode is just copied from the assigned auction definition to avoid performance critical joins when searching for auctions of a defined type.

see AUCTIONDEFINITION

Related Source:

• bc_tendering/javasource/com/intershop/component/tendering/capi/auction/Auction.java
• bc_tendering/edl/com/intershop/component/tendering/capi/auction/Auction.edl

AUCTIONDEFINITION

Data type for attribute typeCode: int

predefined values:

Related Sources:

• bc_tendering/javasource/com/intershop/component/tendering/capi/auction/AuctionDefinition.java
• bc_tendering/edl/com/intershop/component/tendering/internal/auction/AuctionDefinitionPO.edl
• bc_tendering/edl/com/intershop/component/tendering/internal/auction/AuctionPO.edl

BASICADDRESS 

Data type for attribute typeCode: int = 0

Deprecated!

Although type codes still may be set and changed, they are not really used anymore.

Information about the usage of addresses is now stored as custom attributes.

You see this information because remnants of legacy code still manipulate it. It is not used in the storefront though.

Ignore the type code field unless you have a very compelling reason not to do so.

BASICPROFILE

Data type for attribute typeCode: int = 0

The typeCode of a profile is necessary to distinguish between a profile of a 'real' user, profile of a unit or a customer.

The profile type codes are set as follows:

Related sources:

• core/javasource/com/intershop/beehive/core/internal/profile/BasicProfilePO.java
•  core/javasource/com/intershop/beehive/core/capi/profile/ProfileConstants.java

BUDGET

Data type for attribute type: int

Although named type, the attribute works like a type code.

The numeric budget type code is used to distinguish different types of budgets for UI purposes. Currently two different type codes are defined  for interval and schedule budgets.
In the promotion context, the type is set to 1 ( BUDGET_TYPE_SCHEDULE) by default.

Related Source

    bc_organization/edl/com/intershop/component/organization/internal/budget/BudgetPO.edl

CATALOG

Data type for attribute typeCode: int

Related Source

• bc_mvc/javasource/com/intershop/component/mvc/capi/catalog/MVCatalogConstants.java

CATALOGCATEGORYLINK

Data type for the attribute typeCodeInteger : int required column "TYPECODE";

Catalog Category link type codes are realized using the type code definitions.

See also TYPECODEDEFINITION.

Each CatalogCategoryLink has a typeCode. All the typeCodes used by CatalogCategoryLink need to be defined by TypeCodeDefinitions.

The TypeCodeDefinitions must have a TypeCodeDefinition:Group equal to constant CatalogCategoryLink:TypeCodeDefinitionGroup.

To ensure uniqueness of the TypeCodeDefinition:Name the following naming convention should be used: Use the project name as a prefix for the type code name, followed by an underscore. Standard Intershop will have to use "ES_" as prefix for its type code names.

Data type for attribute typeCode: String  (in the Java interface only this type code attribute is available)

Data type for attribute typeCodeInteger int required — this attribute refers to the database table column TYPECODE

constant TypeCodeDefinitionGroup : string = "CatalogCategoryLink";

Related Sources

• xcs/edl/com/intershop/beehive/xcs/internal/catalog/CatalogCategoryLinkPO.edl
• xcs/edl/com/intershop/beehive/xcs/capi/catalog/CatalogCategoryLink.edl

CHANNELTYPE

Data type for attribute channelTypeCode: int searchable

The type code used to mark a channel repository is of the following type

Relations Between Organization, Repository and Channel Type Codes

 Channel & Repositories TypeCodes are coded based on the Organizations:

Database Tables:

• ORGANIZATION:TYPECODE
• CHANNELTYPE.CHANNELTYPECODE
• REPOSITORY.TYPECODE

COMMODITYGROUP

Data type for attribute typeCode: int

Only type code 0 is used at the moment.

no pre-defined values

CONTRACT

Data type for attribute typeCode: int

old contract implementation bc_mvc

Related source: 

• bc_mvc/javasource/com/intershop/component/mvc/capi/catalog/MVCatalogConstants.java

CONTRACTBASE

Data type for attribute typeCode: int

contract implementation business showcase

RevenueBased

Related sources:

• bc_contract/src/main/java/com/intershop/component/contract/capi/ContractConstants.java
• bc_contract_orm/edl/com/intershop/component/contract/orm/internal/contract/orm/ContractBasePO.edl

DERIVEDPRODUCT

Data type for attribute typeCode: int

The usage is the same as in PRODUCT.

Please note: the possibly changed type code compared to the base code is displayed as if it was the same offer type (offered or not offered) as in the source product.

However, all shared products are always handled as offered products using ProductViewImpl.

DOMAIN

Data type for attribute typeCode: int required

The type code of this domain. Depending on its value, this domain represents the system domain, a site or a mere unit.  It is composed by the composition of three bits that can be found in DomainConstants.

Domain TypeCodes are coded bit-wise too.

Database Tables:

• DOMAIN.TYPECODE

Related source:

• core/javasource/com/intershop/beehive/core/capi/domain/DomainConstants.java

FILTEROBJECTASSIGNMENT

Data type for attribute typeCode: int

describes the handled object type

Related source:

• bc_mvc/javasource/com/intershop/component/mvc/capi/filter/CatalogFilterConstants.java

IMPORTUPDATEDTYPECODE

Data type of column NUMBER(*,0) NOT NULL

no referring PO

The table still exists in the database schemes.

It has been a part of import tracking tables for SQL loader import of products, so it is not used anymore.

Type code values here were the same as defined for the product (see PRODUCT).

ISCOMMENT

Data type for attribute typeCode: int required

Persistent object: CommentPO

By the use of the attribute TypeCode the scope of the comment can be defined.

The scope is defined as a bit mask.

This table lists the pre-defined values:

Related source

• bc_foundation/javasource/com/intershop/component/foundation/capi/comment/CommentsConstants.java

Actually used are at least in parts of Intershop 7 different values

Replication comments:

Other types are still available in the pipeline OrderStatusTracking and also do not confirm with the values in the CommentsConstants class.

It looks like this feature is nowhere used anymore.

Hard coded type codes in the pipeline OrderStatusTracking are: 20, 21, 22, 23, 24, 30, 31 and there is a possibility to provide a custom type code as well.

Please note: The pipeline OrderStatusTracking  is still part of the code basis of Intershop 7 but may be not in use anymore.

More related sources:

• bc_foundation/javasource/com/intershop/component/foundation/internal/comment/CommentPO.java
• bc_foundation/edl/com/intershop/component/foundation/internal/comment/CommentPO.edl
• sld_ch_partner_plugin/staticfiles/cartridge/pipelines/ViewReplicationTask_32.xml
• sld_ch_consumer_plugin/staticfiles/cartridge/pipelines/ViewReplicationTask_52.xml
• sld_enterprise_app/staticfiles/cartridge/pipelines/ViewReplicationTask.xml
• bc_requisition/staticfiles/cartridge/pipelines/OrderStatusTracking.xml

JOURNALENTRY

Data type for attribute typeCode: int

Description: by the use of the attribute typeCode the scope of the journal entry can be defined.

type code not used 

no pre-defined values

MESSAGEBODY

not used anymore

ORGANIZATION

Data type for attribute typeCode: int searchable

TypeCodes of Organizations, see also Concept - Organization:

Database Tables:

• ORGANIZATION.TYPECODE

For the relation to the channel type and repository type codes, see Relations between Organization Repository and Channel type codes

ORGANIZATIONGROUPASSIGNMENT

Data type for attribute typeCode: int searchable

Persistent Object: OrganizationUserGroupAssignmentPO

type code is not used

no pre-defined values

PRICEDEFINITIONPRODUCTBINDING

Data type for attribute typeCode: int

Persistent object: PriceDefinitionProductAssignmentPO

Objects and tables are still there but it is not used .

PRICELIST

Data type for attribute priceType: string<256> required

Uses the name of a TypeCodeDefinition to define the type of the price list type

Type definition group: PriceList

In the standard system the following price types are supported:

• Sale price (ES_SalePrice) — a normal price list price
• Warranty price (ES_WarrantyPrice) — exploited by the warranties which implement their own pricing models atop of price lists
  

To avoid disambiguation, please note that the API-s also expose price types which are different than the values defined in the PriceList group. These types are used to bound a specific name to a price list provider which resolves the actual price. Supported are:

• List price
  
• Cost price
  
• Sale price — a price that may come from a price list
  

These types are defined in com.intershop.component.product.pricing.capi.CommonPriceTypes. Custom projects may define their own price types which are bound to specific price list providers and use them when customizing the back office and the storefront applications.

Related source:

• bc_pricing/edl/com/intershop/component/pricing/internal/pricelist/PriceListPO.edl
• bc_pricing/javasource/com/intershop/component/pricing/dbinit/data/pricing/TypeCodeDefinitionsPriceList.properties

• bc_warranty/javasource/com/intershop/component/warranty/internal/price/ES_WarrantyPrice.java

• - xcs/javasource/com/intershop/beehive/xcs/internal/price/ES_SalePrice.java

• xcs/javasource/com/intershop/beehive/xcs/internal/price/ES_CostPrice.java

• xcs/javasource/com/intershop/beehive/xcs/internal/price/ES_ListPrice.java

• com.intershop.component.product.pricing.capi.CommonPriceTypes .java

PRICESCALEENTRY

Data type for attribute typeCode: int

Related source: bc_pricing/javasource/com/intershop/component/pricing/capi/scale/PriceScaleEntryConstants.java

These type codes are used and supported by IS7.

PRICESCALETABLE

Data type for attribute typeCode: int

Price Scale Table type codes are defined as follows:

Any other number, for example, 10 or 34, are combinations of the listed codes. 10 means a combination of 2 and 8; 34 means a combination of 32 and 2. 

Related source:

• com.intershop.beehive.xcs.capi.product.ProductConstants

Note: Currently Contract List Price and Contract Scaled List Price are not supported by the standard product.

PRICESCALETABLEASSIGNMENT

Data type for attribute typeCode: int

In this table the product assignment for scaled prices for price lists is stored´
The type codes are the same as in PRICESCALETABLE

Note: Currently not used in the standard product but nevertheless maintained.

PRODUCT

Data type for attribute typeCode: int = 0 observable

ProductItems, ProductBundles, ProductMasters and Offers are distinguished using a typeCode.

Product type codes are defined as bit mask:

They can be combined as needed, for example:

• 3 = offer item
• 35 = item that is part of a variation product

Related source:

• xcs/javasource/com/intershop/beehive/xcs/capi/product/ProductConstants.java

Note: The offer flag is obsolete and has no special semantics in IS7. Nevertheless, it is still used by order processing code which supports order routing. This is a feature that is not relevant in IS7. If the offer flag is not maintained, the code will break and unexpected results may occur.

PRODUCTCONFVALD

Data type of attribute validatorType:   string<256> required;

Persistent object:    ProductConfigurationValidator

Uses the name of a TypeCodeDefinition to define the type of the product configuration validator.

Type defnition group:    ProductConfigurationValidator

See: TYPECODEDEFINITION

Related source:

• bc_product_configuration/edl/com/intershop/component/productconfiguration/internal/orm/validator/ProductConfigurationValidatorPO.edl
• bc_product_configuration/javasource/com/intershop/component/productconfiguration/dbinit/data/TypeCodeDefinitionsProductConfigurationValidatorType.properties

PRODUCTCONFOPT

Data type of attribute type: string < 256 >  

Persistent object:   ProductConfigurationOptionPO  

Uses the name of a TypeCodeDefinition to define the type of the product configuration option.

Type definition group:  ProductConfigurationValueType

See: Reference - Type Codes (With Migration Hints From Enfinity Suite 6 to Intershop 7)#TYPECODEDEFINITION

Related source:

• bc_product_configuration/edl/com/intershop/component/productconfiguration/internal/orm/set/ProductConfigurationOptionPO.edl

PRODUCTDATADECLARATION

Data type of attribute typeCode: int required

This table contains data of syndication product mapping rules; the same type codes as PRODUCTDATAMAPPINGRULE

Related source:

• bc_mvc/edl/com/intershop/component/mvc/capi/mapping/ProductDataDeclaration.edl (type codes 1 - 6)

PRODUCTDATADECLARATIONLIST

Data type of attribute typeCode: int required

This table contains data of syndication product mapping rules

Related source:

• bc_mvc/javasource/com/intershop/component/mvc/capi/mapping/ProductDataMappingConstants.java

PRODUCTDATAMAPPINGRULE

Data type of attribute typeCode: int required

This table contains data of syndication product mapping rules. The type codes are hard coded in templates and pipelines.

Related source:

• bc_mvc/edl/com/intershop/component/mvc/internal/mapping/ProductDataMappingRulePO.edl

PRODUCTLINK

Data type for attribute typeCode: String  (in the Java interface only this type code attribute is available)

Data type for attribute typeCodeInteger int required — this attribute refers to the database table column TYPECODE

Product link type codes are now realized using the type code definitions.

See also TYPECODEDEFINITION

Each ProductLink has a typeCode. All the typeCodes used by ProductLink need to be defined by TypeCodeDefinitions.

The TypeCodeDefinitions must have a TypeCodeDefinition:Group equal to constant ProductLink:TypeCodeDefinitionGroup.

To ensure uniqueness of the TypeCodeDefinition:Name, the following naming convention should be used: Use the project name as a prefix for the type code name, followed by an underscore. Standard Intershop will have to use "ES_" as prefix for its type code names.

Attention: The CAPI interface ProductLink deals only with the string representations of typeCodes (TypeCodeDefinition:Name).

constant TypeCodeDefinitionGroup : string = "ProductLink";

Related Sources

• xcs/edl/com/intershop/beehive/xcs/internal/product/ProductLinkPO.edl
• xcs/edl/com/intershop/beehive/xcs/capi/product/ProductLink.edl

PRODUCTLIST

Data type for attribute typeCode: int required

Meant to be used for lists of products like wish lists, shopping lists, etc.

Attribute type code is the Type coder of the product list. Can be used to distinguish different kinds of lists.

Legacy product list type codes are defined as follows:

Related source:

• bc_mvc/javasource/com/intershop/component/mvc/capi/product/ProductListingConstants.java

Product lists are currently used only for wish lists. The ORMWishlistBORepositoryImpl in IS7 creates all wish lists as untyped lists (type code 0). The type code is not relevant anymore although there are still pipelines that refer to it.

These pipelines are still there and able to create shopping lists (requisition templates) and quotes, but they are not used anyhow in the standard product

• ProcessRequisitionTemplate.pipeline
• ProcessGlobalRequisitionTemplate.pipeline
• ProcessQuote.pipeline

This pipeline creates a quote with code 4 (business extension)

• bc_b2b_ext/staticfiles/cartridge/pipelines/ProcessQuote.xml

Related other sources:

• bc_mvc/javasource/com/intershop/component/mvc/capi/product/ProductListingConstants.java
• (IS7 only) bc_wishlist_orm/javasource/com/intershop/component/wishlist/orm/internal/ORMWishlistBORepositoryImpl.java

PRODUCTLISTEVENT

Data type for attribute typeCode: string <256> required

The type code of the product list event is a string like 'Approved', 'Accepted', 'Cancelled'.

Implemented into quotes (type codes are equal to the event names defined in QuoteConstants, meaning can be deducted from the type code value)

Related Sources:

• bc_mvc/javasource/com/intershop/component/mvc/capi/quote/QuoteConstants.java
• bc_mvc/edl/com/intershop/component/mvc/capi/product/ProductListEvent.edl

• bc_mvc/staticfiles/cartridge/queries/quote/SearchQuotesByDomain.query

• bc_mvc/staticfiles/cartridge/queries/quote/SearchQuotesByOwner.query

• bc_mvc/staticfiles/cartridge/queries/quote/SearchQuotesByOwningDomain.query

PRODUCTMAPPINGRULE

Data type for attribute typeCode: int

Currently it has no meaning in the standard product.

Related source:

• bc_mvc/edl/com/intershop/component/mvc/capi/mapping/ProductMappingRule.edl

PROFANITYCHECKENTRY

Data type for attribute typeCode: int required

PROMOTION

Data type for attribute typeCode: int

typeCode is deprecated

RATINGCOMMENT

Data type for attribute typeCode: int

typeCode attribute is deprecated — dedicated assignment tables are used instead

REBATE

Data type of attribute typeCode: int

Type code is not used in the current implementation

REBATECONDITION

Data type of argument typeCode: int

bit mask for operator types

Related source:

• bc_marketing/edl/com/intershop/component/marketing/internal/promotion/condition/RebateConditionPO.edl
• bc_marketing/javasource/com/intershop/component/marketing/internal/promotion/condition/RebateConditionPO.java

REPOSITORY

Data type of argument typeCode: int

Related sources:

• bc_mvc/edl/com/intershop/component/mvc/internal/catalog/RepositoryPO.edl
• bc_mvc/javasource/com/intershop/component/mvc/capi/catalog/MVCatalogConstants.java

For the relation to the channel type and repository type codes see Relations Between Organization Repository and Channel Type Codes.

REQUISITIONAWFSTEP

Data type for attribute typeCode: int = 0 required

Related sources

• bc_requisition/javasource/com/intershop/component/requisition/capi/approval/RequisitionAWFConstants.java
• bc_requisition/edl/com/intershop/component/requisition/internal/approval/RequisitionAWFStepPO.ed

RFQPARAMETERVALUE

Data type for attribute typeCode: int

no predefined values

not used

STATICADDRESS

Data type for attribute typeCode: int

In Intershop 7 values may be set and changed by legacy code.

Do not use these values.

See at #BASICADDRESS.

TYPECODEDEFINITION

Data type for attribute typeCode: int required

Contains type code definitions that can be used with the type codes framework.

There are type code groups that can have defined several type code names.

Every type code name gets assigned an integer type code value that is stored in its typeCode attribute.

The integer value itself is not guaranteed to be constant for a certain name and group over versions or different installations.

So the lookup for the type code definition of a typed object should always be done by group and name via the TypeCodeDefinition.

The assigned type code definition will be stored in the typed object as the integer value in the typeCode attribute of the object or as the type definition name in an attribute of type String.

TYPEDPRODUCTCATEGORYASSM

Data Type for attribute typeCodeInteger : int required column "TYPECODE"

Persistent Object: TypedProductCategoryAssignment

The integer typeCode of the TypedProductCategoryAssignment

This is a TypeCodeDefinition:TypeCode out of the TypeCodeDefinitions with TypeCodeDefinition:Group equal to constant TypedProductCategoryAssignment:TypeCodeDefinitionGroup. Attention: The CAPI interface TypedProductCategoryAssignment deals only with the string representations of typeCodes (TypeCodeDefinition:Name).

 Type code group: TypedProductCategoryAssignment

 See at TYPECODEDEFINITION.

Related Source:

• xcs/edl/com/intershop/beehive/xcs/capi/catalog/AbstractTypedProductCategoryAssignmentPO.edl

USERDELEGATION

Data type of attribute typeCode: int searchable

The type code for custom delegations

Custom delegations handle different types on their own.

Related sources:

• bc_organization/javasource/com/intershop/component/organization/capi/OrganizationConstants.java
• bc_organization/edl/com/intershop/component/organization/internal/delegation/UserDelegationPO.edl

USERGROUP

Data type for attribute typeCode: int

Not used.