Skip to main content

A product search feed response will include details on matching eBay catalog products if they were found using product identifiers or keywords. If a catalog product was not found, a warning message will be returned that indicates that no matching product was found. The following table explains the elements or fields in the product search feed response file.

Sample response file:

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

Field name

Description

CSV: Reference ID

XML:
matchingProducts.referenceID

The seller-provided reference ID from the request. 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).

Occurrence: Always Returned

CSV: Channel ID

XML:
productDetails.channelID

The eBay site on which the product search should be made.

The unique identifiers of the selling site, such as EBAY_USEBAY_GB, or EBAY_IT. If not provided in the request feed, this field defaults to EBAY_US. See Marketplace enumerated values for full list.

Occurrence: Always Returned

CSV: ePID

XML:productDetails.channelID

The eBay product identifier (ePID). Identifies a product in the eBay product catalog.

Occurrence: Always Returned

CSV: Not returned in CSV response

XML:
productDetails.productVersion

For XML only, the version number of the catalog product definition. This version number is incremented each time catalog product is updated

CSV: GTIN

XML: type attribute value of GTIN for productDetails.productIdentifier

Global Trade Item Number (GTIN). If a EAN, ISBN, or UPC exists for the catalog product, the values are returned (from EAN, ISBN, and UPC). For CSV, any GTIN and Brand/MPN associated with the catalog product is also returned in the applicable column.

For XML, any GTIN and Brand/MPN associated with the catalog product is returned with the type of identifier indicated through the type attribute value (see Sample type attribute).

Occurrence: Conditionally Returned

CSV: UPC

XML: type attribute value of UPC for productDetails.productIdentifier

If a Universal Product Codes (UPCs) exists for the catalog product, it will be returned

For an XML sample, see the Sample type attribute.

Occurrence: Conditionally Returned

CSV: ISBN

XML: type attribute value of ISBN for productDetails.productIdentifier

If an International Standard Book Numbers (ISBNs) exists for the catalog product, it will be returned

For an XML sample, see the Sample type attribute.

Occurrence: Conditionally Returned

CSV: EAN

XML: type attribute value of EAN for productDetails.productIdentifier

If a European Article Numbers (EANs) exists for the catalog product, it will be returned

For an XML sample, see the Sample type attribute.

Occurrence: Conditionally Returned

CSV: Brand

XML: type attribute value of BRAND for productDetails.productIdentifier

The manufacturer's brand name of the product. It is always returned if an MPN exists for the product. The Brand/MPN combo unique identifies a product.

For an XML sample, see the Sample type attribute.

Occurrence: Conditionally Returned

CSV: MPN

XML: type attribute value of MPN for productDetails.productIdentifier

If a Manufacturer Product Number (MPN) values that the manufacturer uses to identify this product exists for the catalog product. It is always returned if an MPN exists for the product. The Brand/MPN combo unique identifies a product.

For an XML sample, see the Sample type attribute.

Occurrence: Conditionally Returned

CSV: primaryCategory

XML: productDetails.primaryCategory

The main eBay leaf category for this product.

Occurrence: Always Returned

CSV: additionalCategory

XML: productDetails.additionalCategory

This field is returned if the eBay catalog product can be listed in additional leaf categories besides the one indicated by primaryCategory field. One or more eBay categories associated with the product, not including the primary category, is returned.

Occurrence: Conditionally Returned

CSV: productURL

XML: productDetails.productURL

The URL to the matching product’s product page on eBay.

Occurrence: Always Returned

CSV: title

XML: productDetails.title

The title of the product.

Max length: 80 characters

Occurrence: Always Returned

CSV: Attributes

XML: productDetails.attribute container

Name-value pairs of product attributes. An attribute is often referred to an Item Specific or a product aspect. Example values include Brand, Model, Type, Color, and Features. The number of defined attributes vary by category, and some categories have much more than others. Some item specifics can have multiple values.

CSV

CSV uses the following syntax for name/value pairs: name1=value1|name2=value2|name3=value3.

Brand=Apple|MPN=MGAL2LLA|Processor=Dual Core

XML

For XML, an attribute container is included for each item specific name/value pair.

<attribute>
	<name>Brand</name>
	<value>Apple</value>
</attribute>

Occurrence: Conditionally Returned

CSV: PictureURL

XML: productDetails.pictureURL

A stock photo defined for the catalog product. Most catalog products have at least one stock photo.

Occurrence: Conditionally Returned

CSV: description

XML: productDetails.description

The description of the product, as defined in the eBay catalog product definition. Most catalog products have a description defined.

Occurrence: Conditionally Returned

CSV: Message Type

XML: messageInfo.messageType

The type of error or warning. This field is only returned if there was an issue with the product search.

Occurrence: Conditionally Returned

CSV: Message ID

XML: messageInfo.messageID

The unique identifier of the error or warning. This field is only returned if there was an issue with the product search.

Occurrence: Conditionally Returned

CSV: Message

XML: messageInfo.message

The actual text of the error or warning. This field is only returned if there was an issue with the product search. This field can include information about errors and how to correct them.

Occurrence: Conditionally Returned

Sample type attribute (XML)

If an identifier exists for the catalog product, it will be returned as a type in the productDetails.productIdentifier container.

<productDetails>
	<channelID>EBAY_US</channelID>
	<ePID>27056252015</ePID>
	<productVersion>6</productVersion>
	<productIdentifier type="BRAND">Apple</productIdentifier>
	<productIdentifier type="MPN">MQ903LLA</productIdentifier>
	<productIdentifier type="GTIN">0194253378877</productIdentifier>
	<productIdentifier type="GTIN">0400064872665</productIdentifier>
	<productIdentifier type="UPC">0194253378877</productIdentifier>
	<productIdentifier type="UPC">0400064872665</productIdentifier>
	<productIdentifier type="EAN">0194253378877</productIdentifier>
	<productIdentifier type="EAN">0400064872665</productIdentifier>
</productDetails>