Product Catalog Appendix A - File Field Definitions

Agathe - Technical Writer

Last edited: December 01, 2023 18:57

This is an appendix to the Product Catalog Implementation Guidelines.

This Appendix contains the fields you will see in your Product Catalog file; * indicates a required field. Click on the + for more information on each field:

Product Field: 1 | Name: Product ID

Data Type (Max Length): Number

Required/Optional: Optional

Key: Unique ID that is used to identify a product. It will be an integer greater than 2 and have less than 31 total characters.

Product Field: 2 | Name: Product Name *

Data Type (Max Length): Text (255)

Required/Optional: Required

Key: Name of the product.

Product Field: 3 | Name: SKU Number *

Data Type (Max Length): Text (64)

Required/Optional: Required

Key: SKU Number. A majority of advertisers provide a unique value in this field. Some advertisers provide duplicate SKU values and as such duplicate SKUs for select advertisers will be available in some Product Catalog feed files.

Product Field: 4 | Name: Primary Category *

Data Type (Max Length): Text (50)

Required/Optional: Required

Key: Primary product category.

Product Field: 5 | Name: Secondary Category

Data Type (Max Length): Text (500)

Required/Optional: Optional

Key: Secondary product categories, delimited with double tildes (~~).

Product Field: 6 | Name: Product URL *

Data Type (Max Length): Text (2000)

Required/Optional: Required

Key: URL of the product page.

Product Field: 7 | Name: Product Image URL *

Data Type (Max Length): Text (2000)

Required/Optional: Required

Key: URL of product image. This will be an absolute URL.

Product Field: 8 | Name: Buy URL

Data Type (Max Length): Text (2000)

Required/Optional: Optional

Key: URL of shopping cart with product.

Product Field: 9 | Name: Short Product Description

Data Type (Max Length): Text (500)

Required/Optional: Optional

Key: Short description of the product.

Product Field: 10 | Name: Long Product Description

Data Type (Max Length): Text (2000)

Required/Optional: Optional

Key: Long description of product.

Product Field: 11 | Name: Discount

Data Type (Max Length): Number

Required/Optional: Optional

Key: Relies on discount type (below) to determine how to apply. If Discount Type is amount, then discount is deducted. If it is percentage, then percentage is deducted. The format uses either a decimal point or a comma.

Product Field: 12 | Name: Discount Type

Data Type (Max Length): Text (10)

Required/Optional: Optional

Key: Values: amount of percentage.

Product Field: 13 | Name: Sale Price

Data Type (Max Length): Number

Required/Optional: Optional

Key: This price reflects any discounts. The format uses either a decimal point or a comma.

Product Field: 14 | Name: Retail Price *

Data Type (Max Length): Number

Required/Optional: Required

Key: This price does not reflect any discounts. The format uses either a decimal point or a comma.

Product Field: 15 | Name: Begin Date

Data Type (Max Length): Date (mm/dd/yyyy hh:mm:ss)

Required/Optional: Optional

Key: Date and time that the product becomes available. The format uses either a decimal point or a comma.

Product Field: 16 | Name: End Date

Data Type (Max Length): Date (mm/dd/yyyy hh:mm:ss)

Required/Optional: Optional

Key: Date and time that the product ceases to be available. The format uses either a decimal point or a comma.

Product Field: 17 | Name: Brand

Data Type (Max Length): Text (255)

Required/Optional: Optional

Key: Brand.

Product Field: 18 | Name: Shipping

Data Type (Max Length): Number

Required/Optional: Optional

Key: The cost of the default shipping option available. The format uses either a decimal point or a comma.

Product Field: 19 | Name: Keyword(s)

Data Type (Max Length): Text (500)

Required/Optional: Optional

Key: Keywords for searches, delimited with double tildes (~~).

Product Field: 20 | Name: Manufacturer Part Number

Data Type (Max Length): Text (50)

Required/Optional: Optional

Key: Manufacturer’s part number (may sometimes be the same as SKU).

Product Field: 21 | Name: Manufacturer Name

Data Type (Max Length): Text (250)

Required/Optional: Optional

Key: Manufacturer’s name.

Product Field: 22 | Name: Shipping Information

Data Type (Max Length): Text (50)

Required/Optional: Optional

Key: Text-based shipping information. Provides details on the default shipping option.

Product Field: 23 | Name: Availability

Data Type (Max Length): Text (50)

Required/Optional: Optional

Key: Denotes whether the product is in stock. Values will be one of "in-stock," "out-of-stock," "preorder," or "backorder."

Product Field: 24 | Name: Universal Product Code

Data Type (Max Length): Text (15)

Required/Optional: Optional

Key: Universal Product Code. May be UPC, EAN or JAN.

Product Field: 25 | Name: Class ID

Data Type (Max Length): Number

Required/Optional: Optional

Key: Classification ID based on product type.

Product Field: 26 | Name: Currency *

Data Type (Max Length): Text (3)

Required/Optional: Required

Key: The 3-character ISO Currency Code. Use "USD" for U.S. dollar, "CAD" for Canadian dollar, "GBP" for British pound, "JPY" for Japanese yen, "AUD" for Australian dollar, or "EUR" Euro. USD is default.

Product Field: 27 | Name: M1

Data Type (Max Length): Text (2000)

Required/Optional: Optional

Key: Blank field unless other arrangements have been made.

Product Field: 28 | Name: Pixel

Data Type (Max Length): Text (128)

Required/Optional: Optional

Key: 1x1 pixel tag used to track impression data for the link. This is a full tag with all appropriate attributes. See Appendix D for sample records.

Product Field: 29 | Name: Attribute 1

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 30 | Name: Attribute 2

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 31 | Name: Attribute 3

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 32 | Name: Attribute 4

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 33 | Name: Attribute 5

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 34 | Name: Attribute 6

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 35 | Name: Attribute 7

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 36 | Name: Attribute 8

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 37 | Name: Attribute 9

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 38 | Name: Attribute 10

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: See Appendix B.

Product Field: 39-50 | Name: Attribute 11-12

Data Type (Max Length): See Appendix B.

Required/Optional: Optional

Key: Only applicable for Class ID 150: Credit Cards. See Appendix B.

Product Field: 39 (51) | Name: Modification *

Data Type (Max Length): Chart (1)

Required/Optional: Required for delta files.

Key: Available only in Delta files. I = Insert U = Update D = Delete.

Certain entries are required fields. If an advertiser does not submit attribute data, their Product Catalog file still contains 38 fields (39 fields in delta files).