CatalogEntry

Use the CatalogEntry keyword to load catalog entries (products, SKUs, bundles, and kits) and the catalog entries calculation code.

Previously, you could load this data only in CSV formatted files. We can now load information in a CSV or XML formatted input file. Your input file must contain CSV column or XML element names and definitions that specify the characteristics of the business object type we are loading into the database.

CSV column and XML element definitions

PartNumber

(String) The unique part number of the catalog entry. This field cannot be null in Insert or Replace. In Delete, either this field or the CatalogEntryUniqueId is required. The part number for a catalog entry displays in Management Center as the value for the catalog entry Code property.

CatalogEntryUniqueId

(Integer) The internal unique reference number of the catalog entry. In Delete, either this field or the PartNumber is required.

Type

(String) The type of catalog entry to load in this row. Valid values are:

• Item (use this type to load SKUs)

• Product

• Bundle

• Package (use this type to load kits)

• Dynamic kit

ParentPartNumber

(String) The part number of the parent product.

ParentUniqueId

(Integer) The internal unique reference number of the parent catalog entry.

ParentGroupIdentifier

(String) The identifier of the parent category.

ParentGroupUniqueId

(Integer) The unique reference number of the parent category.

ParentStoreIdentifier

(String) The identifier of the store that owns the parent category.

ParentStoreUniqueId

(Integer) The unique reference number of the store that owns the parent category.

CurrencyCode

(String) The currency of the DefaultOfferPrice or the ListPrice. This code is a currency code as per ISO 4217 standards.

ListPrice

(Decimal) The list price of this catalog entry in the currency specified.

Price

(Decimal) The offer price of this catalog entry in the currency specified. Default is 0.00.

Sequence

(Decimal) An optional number used to control the order in which the catalog entry displays in a category. If the parent product is provided, this sequence is an optional number used to control the order in which the items display in a parent product. Products and SKUs are displayed in ascending order within their parent category or product. For example, if A is 1.1 and B is 2.0, then A is displayed before B.

LanguageId

(Integer) The language ID for language-specific fields (Name, ShortDescription, LongDescription, AuxDescription1, AuxDescription2, Thumbnail, FullImage, Published, and Keyword). For example:

• -1 (for English

• -2 for French

Name

(String) The language-specific display name of this catalog entry.

ShortDescription

(String) The language-specific short description of this catalog entry.

LongDescription

(String) The language-specific long description of this catalog entry.

Thumbnail

(String) The language-specific thumbnail image path of this catalog entry. For example, images/G1.jpg.

For the Aurora starter store, this path must be to the 160-pixel-wide thumbnail image of this catalog entry, for example:
images/catalog/apparel/women/womens_dresses_160x160/WD_038_a_blue.jpg
This path must have a directory with a name containing the following character string: 160x160. The server matches the character string to locate this image and the other catalog entry images in different sizes.

FullImage

(String) The language-specific full image path of this catalog entry. For example, images/G1.jpg.

For the Aurora starter store, this path must be to the 1000-pixel-wide full image of this catalog entry, for example:
images/catalog/apparel/women/womens_dresses_1000x1000/WD_038_a_blue.jpg
This path must have a directory with a name containing the following character string: 1000x1000. The server matches the character string to locate this image and the other catalog entry images in different sizes. The 1000-pixel-wide full image is not currently used in the Aurora storefront.

Angle1_FullImage

The first angle full image for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle1_Thumbnail

The first angle thumbnail for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle2_FullImage

The second angle full image for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle2_Thumbnail

The second angle thumbnail for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle3_FullImage

The third angle full image for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle3_Thumbnail

The third angle thumbnail for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle4_FullImage

The fourth angle full image for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle4_Thumbnail

The fourth angle thumbnail for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle5_FullImage

The fifth angle full image for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

Angle5_Thumbnail

The fifth angle thumbnail for this catalog entry. This image can be used when Watson Content Hub integration is enabled.

AuxDescription1

(String) The language-specific auxiliary long description of this catalog entry.

Maximum number of characters: 4000

AuxDescription2

(String) The language-specific auxiliary description of this catalog entry.

Available

(Integer) Indicates the length of time of availability of this catalog entry. This field is for our internal business use and information only. Do not use this column to indicate inventory levels. The default value is 1.

Published

(Integer) Indicates whether to display this catalog entry on the storefront:

0

Do not display this catalog entry.

1

Display this catalog entry.

AvailabilityDate_LocaleSpecific

(Timestamp) The date this catalog entry becomes available.

Keyword

(String) Language-specific keywords used for searching. Some Internet search engines use these keywords to determine whether your page satisfies a search query. To include multiple keywords that are separated by commas, include the entire string in double quotation marks. Example "keyword 1, keyword 2, keyword3".

ManufacturerPartNumber

(String) The manufacturer part number of this catalog entry.

Manufacturer

(String) The name of the manufacturer.

OnSpecial

(Integer) A flag to identify if this catalog entry is on special.

OnAuction

(Integer) A flag to identify if this catalog entry is on auction.

Buyable

(String) Indicates whether this catalog entry can be purchased individually:

0

The catalog entry cannot be purchased.

1

The catalog entry can be purchased.

StartDate

(Timestamp) The date the catalog entry is introduced. This date is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

EndDate

(Timestamp) The date the catalog entry is removed. This date is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

URL

(String) The URL to this catalog entry which can be used as the downloadable URL for the soft goods. Use a forward slash '/' as the directory and path separator.

Maximum number of characters: 254

Field1

(Integer) A user-defined field available for customization purposes.

Field2

(Integer) A user-defined field available for customization purposes.

Field3

(Decimal) A user-defined field available for customization purposes.

Field4

(String) A user-defined field available for customization purposes.

Field5

(String) A user-defined field available for customization purposes.

AvailabilityDate

(Timestamp) The date that the product is available to customers for purchase. This date is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

LastOrderDate

(Timestamp) The final date that the product is available for order. This date is the latest date that a customer can order the product. This date is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

EndOfServiceDate

(Timestamp) The date a product is no longer in service. For example, this date can be the date that a software manufacturer stops providing upgrades for a version of their product. This date is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

DiscontinueDate

(Timestamp) The date when the product is discontinued. For example, this date can be the date that a manufacturer stops producing a product, or the date the store stops selling the product. IBM recommends that this date is used consistently to avoid confusion. This field is for administrative information only. Use the format yyyy-mm-dd hh:mm:ss.millis.

WeightMeasure

(String) The International System of Units (SI) unit of measurement code for the catalog entry weight.

Weight

(Decimal) The weight of the catalog entry.

Length

(Decimal) The length of the catalog entry.

Width

(Decimal) The width of the catalog entry.

Height

(Decimal) The height of the catalog entry.

SizeMeasure

(String) The unit of measurement for Length, Width, and Height.

NominalQuantity

(Decimal) A nominal quantity for a product, which is used for pricing. For example, if a product is priced as "3 for a dollar", then the nominal quantity of the product is 3. The price of the product is one dollar. Default is 1.0.

QuantityMultiple

(Decimal) The product can be sold in quantities that are multiples of this quantity. Default is 1.0.

QuantityMeasure

(String) The unit of measurement for NominalQuantity and QuantityMultiple. Default is 'C62'. C62 is the UN/CEFACT code that represents 'one'.

ParentToChildCatEntryRelField1

(String) Customizable field for the parent product to child SKU relationship.

Maximum number of characters: 254

ParentToChildCatEntryRelField2

(Integer) Customizable field for the parent product to child SKU relationship.

ParentToChildCatEntryRelField3

(Decimal) Customizable field for the parent product to child SKU relationship.

DiscountCalculationCode

(String) The catalog entry discount calculation code.

DiscountCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry discount calculation code.

ShippingCalculationCode

(String) The catalog entry shipping calculation code.

ShippingCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry shipping calculation code.

SalesTaxCalculationCode

(String) The catalog entry sales tax calculation code.

SalesTaxCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry sales tax calculation code.

ShippingTaxCalculationCode

(String) The catalog entry shipping tax calculation code.

ShippingTaxCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry shipping tax calculation code.

CouponCalculationCode

(String) The catalog entry coupon calculation code.

CouponCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry coupon calculation code.

SurchargeCalculationCode

(String) The catalog entry surcharge calculation code.

SurchargeCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry surcharge calculation code.

ShippingAdjustmentCalculationCode

(String) The catalog entry shipping adjustment calculation code.

ShippingAdjustmentCalculationCodeUniqueId

(Integer) The unique reference number of the catalog entry shipping adjustment calculation code.

SUBSCPTYPE_ID

(CHAR(32)) The identifier of the subscription type that the catalog entry can be subscribed to.

NONE

Not a subscription.

TIME-BASED

Time-based subscription.

EVENT-BASED

Event-based subscription.

TIME-EVENT-BASED

Time and event-based subscription.

DISALLOW_REC_ORDER

(Integer) Indicates whether the catalog entry is prohibited from being purchased through recurring order.

0

No. This value is the default value.

1

Yes

Delete

(String) A flag that indicates whether to delete. Specify 1 to delete the row.