eBay Shopping APIVersion 1085

CatalogProductType

This complex type is used by each Product container that is returned Information about an eBay catalog product.

Type that uses CatalogProductType:

Call that uses CatalogProductType:

Fields



DetailsURL ( anyURI ) [0..1]
The fully-qualified URL to the eBay product page is displayed in this field. The user can grab this URL, paste it in a browser, and view the product page on the eBay marketplace. Note that some product pages will have active listings associated with them, and some will not.

Applications can include this URL as a link in product search results, so that end users can view additional descriptive details about the product.
See the Field Index to learn which calls use DetailsURL.

DisplayStockPhotos ( boolean ) [0..1]
If this field is returned as true, there is a stock photo associated with the catalog product, and the URL to this image file is shown in the StockPhotoURL field. If this field is returned as false, there is no stock photo associated with the catalog product.

Sellers should be aware that if no stock photo exists for a catalog product, the seller must add at least one of their own photos when creating a listing (based on that catalog product), as all eBay listings must have at least one image.

An application incorporating a graphical user interface can use this flag to determine when to hide customized stock photo widgets.

This field is always returned in each Product container.
See the Field Index to learn which calls use DisplayStockPhotos.

DomainName ( string ) [0..1]
The name of the eBay category-related domain most closely associated with the catalog product. If the catalog product is associated with multiple category-related domains, eBay returns the most applicable domain (as determined by eBay).

This field is only returned if a catalog product is associated with one or more category-related domains, and if eBay has this data available.
See the Field Index to learn which calls use DomainName.

ItemCount ( int ) [0..1]
Not used by any call.

This field is no longer applicable since the FindProducts call no longer retrieves any data on active listings associated with the retrieved catalog products.
See the Field Index to learn which calls use ItemCount.

ItemSpecifics ( NameValueListArrayType ) [0..1]
This array contains a list of Item Specifics (also referred to as Product Asepcts) defined for the catalog product. Item Specifics provide desciptive details of an item in a structured manner.

Scanning Item Specific name-value pairs for catalog products in the response can be useful if the user would like to expand the query string to return more precise results. For example, if a user specified 'iPhone 8' as the query string in the call request, but after seeing too many catalog products of phones in different colors, and with different storage capacities in the response, the user could run another call, but expand the query string to 'iphone 8 256GB Gray'. In this case, the user would only see iPhone 8s that are gray and have 256 GB of storage capacity.

Important: Most eBay catalog products have at least one to a few Item Specifics defined, but it is possible that some retrieved catalog products will not have any Item Specifics.
See the Field Index to learn which calls use ItemSpecifics.

ProductID ( ProductIDType (string) ) [0..*]
At least one ProductID field is always returned with each Product container, as this value is the unique identifier (ePID) of the eBay catalog product. Any Global Trade Item Numbers (such as ISBN, EAN, UPC, or MPN) are also returned if defined in the catalog product record. The field's type attribute indicates the product identifier type. For ePIDs, the type attribute value is Reference. The ISBN, EAN, and UPC values can be useful as keys if your application is comparing products across different sites.

See the ProductIDCodeType definition to view the applicable enumeration values for the lt;b>typelt;/b> attribute.
See the Field Index to learn which calls use ProductID.

ProductState ( ProductStateCodeType ) [0..1]
The enumeration value in this field provides information on the current state of the catalog product record. This field is generally only returned if the catalog product record was recently updated, is due for an update, or if the record is scheduled to be deleted.
See the Field Index to learn which calls use ProductState.

ReviewCount ( int ) [0..1]
This integer value indicates the total number of reviews that are available for the catalog product on the eBay Web site. Not all products will have reviews on an eBay marketplace, but if reviews are available for a catalog product, product reviews should be accessible from the catalog product page (see corresponding DetailsURL field).
See the Field Index to learn which calls use ReviewCount.

StockPhotoURL ( anyURI ) [0..1]
The fully-qualified URL to the catalog product's stock photo. This field is only returned if a stock photo exists for the eBay catalog product. Generally, this is the image that eBay displays in product-based search results.
See the Field Index to learn which calls use StockPhotoURL.

Title ( string ) [0..1]
The title of the product, as it is defined in the catalog product record. This field is always returned with each Product container.
See the Field Index to learn which calls use Title.