Reference > Data load utility CSV column definitions
Catalog entry
Use the CatalogEntry keyword to load catalog entries (products, SKUs, bundles and kits) and the catalog entries calculation code into the database using a CSV file. The CSV file contains column definitions specifying the characteristics of the catalog business object type.
CSV file column 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.
- CatalogEntryUniqueId
- (Integer) The internal unique reference number of the catalog entry. In Delete, either this field or the PartNumber is required.
- ParentPartNumber
- (String) This is the part number of the parent product if the catalog entry is a SKU.
- 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.
- Type
- (String) This field defines the type of catalog entry to load. The values for Type are "Item, "Product", "Bundle", "Package" and "DynamicKit".
- CurrencyCode
- (String) The currency of the DefaultOfferPrice or the ListPrice. This is a currency code as per ISO 4217 standards.
- DefaultOfferPrice
- (Decimal) The offer price of this catalog entry in the currency specified. The default value = 0.00 .
- ListPrice
- (Decimal) The list price of this catalog entry in the currency specified.
- Sequence
- (Decimal) An optional number used to control the order in which the catalog entry appears in a category. If the parent product is provided, this is an optional number used to control the order in which the items appears in a parent product.
- LanguageId
- (Integer) The language id for language sensitive fields (Name, ShortDescription, LongDescription, AuxDescription1, AuxDescription2, Thumbnail, FullImage, Published, and Keyword). For example: -1 for English, -2 for French
- Name
- (String) The display name of this catalog entry. This field is language sensitive.
- ShortDescription
- (String) A short description of this catalog entry. This field is language sensitive.
- LongDescription
- (String) A long description of this catalog entry. This field is language sensitive.
- Thumbnail
- (String) The thumbnail image path of this catalog entry. This field is language sensitive. The forward slash '/' should be used in the path. Do not use backward slash '\'. For example, images/G1.jpg.
- FullImage
- (String) The full image path of this catalog entry. This field is language sensitive. The forward slash '/' should be used in the path. Do not use backward slash '\'. For example, images/G1.jpg .
- AuxDescription1
- (String) An auxiliary long description of this catalog entry. This field is language sensitive.
- AuxDescription2
- (String) An auxiliary description of this catalog entry. This field is language sensitive.
- Available
- (Integer) Indicates the length of time of availability of this catalog entry. Do not use this column to indicate inventory levels. Default value = 1.
- Published
- (Integer) Indicates whether this catalog entry should be displayed. : 0 = catalog entry should not be displayed, 1= catalog entry should be displayed.
- AvailabilityDate_LocaleSpecific
- (Timestamp) The date this catalog entry becomes available.
- Keyword
- (String) A keyword used for searching.
To include multiple keywords, separated by commas, include the entire string in double quotes. Example "keyword 1, keyword 2, keyword3". This field is language sensitive.
- ManufacturerPartNumber
- (String) The manufacturer part number of this catalog entry.
- Manufacturer
- (String) The name of the manufacturer.
- OnSpecial
- (Integer) This flag identifies if this catalog entry is on special.
- OnAuction
- (Integer) This flag identifies if this catalog entry is on auction.
- Buyable
- (Integer) Indicates whether this catalog entry can be purchased individually: 1 = yes and 0 = no.
- StartDate
- (Timestamp) The date the catalog entry is introduced. This field 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 field 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. Only the forward slash '/' is allowed to be used as the directory and path separator.
- 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 field 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 is the latest date a customer can order the product. This field 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 field 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 a manufacturer stops producing a product, or the date the store stops selling the product. IBM recommends that this column be 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, used for pricing. For example, if a product is priced as "3 for a dollar", then the nominal quantity of the product is 3, and the price of the product is one dollar. Default = 1.0 .
- QuantityMultiple
- (Decimal) The product can be sold in quantities that are multiples of this quantity. Default = 1.0 .
- QuantityMeasure
- (String) The unit of measurement for NominalQuantity and QuantityMultiple. The default value is 'C62'. C62 is the UN/CEFACT code that represents 'one'.
- ParentToChildCatEntryRelField1
- (String) Customizable field for the parent product to child SKU relationship.
- 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.
- ShipCalculationCode
- (String) The catalog entry shipping calculation code.
- ShipCalculationCodeUniqueId
- (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.
- ShipTaxCalculationCode
- (String) The catalog entry shipping tax calculation code.
- ShipTaxCalculationCodeUniqueId
- (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.
- ShipAdjustmentCalculationCode
- (String) The catalog entry shipping adjustment calculation code.
- ShipAdjustmentCalculationCodeUniqueId
- (Integer) The unique reference number of the catalog entry shipping adjustment calculation code.
- Delete
- (String) Indicates whether to delete. If you are performing a delete operation, specify this column. A value of "1" indicates that the row should be deleted.