eBay Trading API Version 951

ProductListingDetailsType

Type used by the ProductListingDetails container which is used by a seller in an add/revise/relist call to identify a product through a Global Trade Identification Number (EAN, ISBN, UPC, etc.) and provide other information about that product. Just a unique product identifier along with help the seller pre-fill the listing information.

Type that uses ProductListingDetailsType:

Calls that use ProductListingDetailsType:

Fields



BrandMPN ( BrandMPNType ) [0..1]
Applicable for listing use cases only (not buy-side searching). The combination of Brand and MPN (manufacturer part number) can be used as a unique identifier for a product. If this container is used, both Brand and MPN must be specified.

It is a best practice to also specify the Brand/MPN values in two separate ItemSpecifics.NameValueList containers. The values in the BrandMPN container are used to look for an eBay catalog product match, but if a match is not found, these Brand and MPN values are dropped from the listing. By also specifying these Brand and MPN values in Item Specifics, these values are retained in the listing. If the Brand and MPN values in the BrandMPN container and ItemSpecifics.NameValueList containers differ, the values in the ItemSpecifics.NameValueList containers will overwrite the values of the BrandMPN container.

Note: The BrandMPN container (and eBay catalog product lookup) is not supported for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container.
See the Field Index to learn which calls use BrandMPN.

Copyright ( string ) [0..*]
Copyright statement indicating the source of the product information. This information will be included in the listing with Pre-filled Item Information. Your application should also display the copyright statement when rendering the Pre-filled Item Information. If more than one copyright statement is applicable, they can be presented to the user in alphabetical order. Returned as HTML. Output only.
See the Field Index to learn which calls use Copyright.

DetailsURL ( anyURI ) [0..1]
Not used by any call.

Fully qualified URL for eBay's product details page, which contains optional information about the product (such as a movie's description or film credits). This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link so that end users can view additional descriptive details about the product.

Note: You can use the ProductMementoString parameter in this URL as the ProductID value in GetSearchResults requests. This parameter is a colon-delimited alphanumeric value. For an example of how to use this string, see the GetProducts samples in the Trading API Guide.
See the Field Index to learn which calls use DetailsURL.

EAN ( string ) [0..1]
Applicable for listing use cases only (not buy-side searching). EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
See the Field Index to learn which calls use EAN.

IncludeeBayProductDetails ( boolean ) [0..1]
This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing. If a product identifier value is provided through the ProductListingDetails container when adding, revising, or relisting an item, the default behavior is for eBay to try and find a match for the product in the eBay product catalog, and then automatically create the listing title, item specifics, item description, pictures (for "New" condition items), and assign a category.

If the seller wants to use the eBay product catalog to help create or revise the listing, the seller can include this field and set its value to true, or just omit this field, as it default value is true. If a seller doesn't want the eBay product catalog information in their listing, that seller would have to include this field and set its value to false. If the seller does this, they will also be required to pass in their own listing title and description, item specifics, and pictures, and select a listing category.

Note: Beginning with version 939, this boolean field has essentially replaced the soon-to-be deprecated IncludePrefilledItemInformation boolean field. However, the IncludePrefilledItemInformation boolean field will still work with versions prior to 939 until March 2017.
See the Field Index to learn which calls use IncludeeBayProductDetails.

IncludeStockPhotoURL ( boolean ) [0..1]
If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free).

Along with these changes, IncludeStockPhotoURL will be used in the request. In some cases, if IncludeStockPhotoURL is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information.


Not applicable to Half.com.
See the Field Index to learn which calls use IncludeStockPhotoURL.

ISBN ( string ) [0..1]
Applicable for listing use cases only (not buy-side searching). ISBN is a unique identifer for books (an international standard). Specify a 10 or 13-character ISBN. If you specify the 13-character ISBN, the value must begin with either 978 pr 979. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
See the Field Index to learn which calls use ISBN.

ProductDetailsURL ( anyURI ) [0..1]
Not used by any call.

Fully qualified URL for eBay's product details page, which contains optional information about the product (such as a movie's description or film credits). This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link so that end users can view additional descriptive details about the product.
See the Field Index to learn which calls use ProductDetailsURL.

ProductID ( string ) [0..1]
eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter product ID (ePID) value that is displayed on the eBay Web site, see ProductReferenceID instead.)

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed.

Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted.
See the Field Index to learn which calls use ProductID.

ProductReferenceID ( string ) [0..1]
eBay's short global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID" or "Product ID". This type of product ID is a fixed reference to a product (regardless of version). Multiple (versioned) ProductID values can be associated with a single product reference ID. You can find product reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the product ID on eBay's Web site (a numeric value prefixed with "EPID"). You can pass the value with or without the "EPID" prefix; for example "EPID228742" or "228742" (without quotes).

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may return an error if the product has been deleted.
See the Field Index to learn which calls use ProductReferenceID.

ReturnSearchResultOnDuplicates ( boolean ) [0..1]
Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, Brand-MPN combination) or event specified through TicketListingDetails. Also see UseFirstProduct as an alternative.

If true and more than one match is found, the call fails and the response returns an error and all matching Product ID values. This lets you choose one of the Product IDs to pass in instead. If false and more than one match is found, the call fails and the response includes an error but does not return the matching Product ID values. (This flag has no effect when only one match is found.)
See the Field Index to learn which calls use ReturnSearchResultOnDuplicates.

StockPhotoURL ( anyURI ) [0..1]
Fully qualified URL for a standard image (if any) that is associated with the product. A seller includes the stock photo in the listing by setting IncludeStockPhotoURL.
See the Field Index to learn which calls use StockPhotoURL.

TicketListingDetails ( TicketListingDetailsType ) [0..1]
Applicable for listing use cases only (not buy-side searching). Only applicable when you are listing event tickets. Please note that the US eBay site and other sites may also require you to specify additional Item Specifics by using AttributeSetArray. This may depend on the location of the event. See the eBay Trading API Guide for more information about how to specify and troubleshoot these values.
See the Field Index to learn which calls use TicketListingDetails.

UPC ( string ) [0..1]
Applicable for listing use cases only (not buy-side searching). UPC is a unique, 12-character identifier that many industries use to identify products.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
See the Field Index to learn which calls use UPC.

UseFirstProduct ( boolean ) [0..1]
Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, BrandMPN, or TicketListingDetails). Also see ReturnSearchResultOnDuplicates as an alternative. If more than one product match was found and UseFirstProduct is true, item will be listed with first product information. If false, the rules for ReturnSearchResultOnDuplicates are used.
See the Field Index to learn which calls use UseFirstProduct.

UseStockPhotoURLAsGallery ( boolean ) [0..1]
If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See the eBay Trading API guide for additional validation rules for pictures.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free).

Along with these changes, UseStockPhotoURLAsGallery will be used in the request. In some cases, if UseStockPhotoURLAsGallery is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information.

See the Field Index to learn which calls use UseStockPhotoURLAsGallery.