Skip to main content

This topic provides definitions for the fields in a product search feed.

Sample feed files:

Note: The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file.

Field name

Description

CSV: Reference ID

XML: productSearch.referenceID

Required. Reference ID to correlate request to responses. This can be an eBay Product ID (ePID), or from a set of values to set the type of ID being passed in to the Product Identifier field (see Available Reference ID values).

Type: string

CSV: Channel ID

XML: productSearch.channelID

Required. The eBay marketplace/channel on which to conduct the product search, such as EBAY_US, EBAY_GB, or EBAY_IT, and others. If not provided, this field defaults to EBAY_US. See Marketplace enumerated values for full list.

Type: string

CSV: Product Identifier

XML: productSearch.productIdentifier

Required if you do not provide a keyword. A standard product identifier, such as a BRAND, UPC , ISBN, EAN, or MPN value, in the eBay product catalog. The search will try to match the GTIN value to an eBay catalog product.

You must use either a product identifier or a keyword.

Type: string

CSV: Category

XML: productSearch.category

Optional. The eBay category ID. This field can be used with keywords or attributes.

Type: string

CSV: Keywords

XML: productSearch.keywords

Required if you do not provide a product identifier. Keywords used to search for matching products.

You must use either a product identifier or a keyword.

Type: string

CSV: Attributes

XML: productSearch.attributes

Optional. A list of product attributes to match.

An attribute element contains a name key and value pair describing the product. Limit of 25.

Note: Attributes are also known as item specifics.

The format for the attribute values is a|b|c where a, b, and c are the name value pairs. The values are separated by the pipe ( | ) symbol.

For example:

Brand:Apple|Model:iPhone 6|Processor:Dual Core

For XML input files, a separate productSearch.attribute container is needed for each attribute name/value pair.

Type: string