eBay Trading API927

ProductListingDetailsType

Contains product information that can be included in a listing. Applicable for listings that use eBay's Pre-filled Item Information feature and listings in categories that require product identifiers. See Pre-filling Item Specifics with Product Details for details on working with Pre-filled Item Information.

Types that use ProductListingDetailsType:

Calls that use ProductListingDetailsType:

Fields



BrandMPN ( BrandMPNType ) [0..1]
The combination of Brand and MPN (manufacturer part number) can be used as a unique identifier for a product. This brand/MPN pair is used to match the product with a product in the eBay catalog and to pick up that product's item title, item description, item specifics, and stock photos. Both Brand and MPN should be specified to increase the odds of finding a product match in the eBay Catalog.

Note: It is recommended that you specify this brand/MPN pair through this container and through two ItemSpecifics.NameValueList containers because if you only specify this pair through this container and a product match is not found, the listing will be blocked and the brand and MPN values will be dropped.
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.
See the Field Index to learn which calls use Copyright.

DetailsURL ( anyURI ) [0..1]
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 DetailsURL.

EAN ( string ) [0..1]
EAN (European Article Number) is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products. This value is used to match the product with a product in the eBay catalog and to pick up that product's item title, item description, item specifics, and stock photos.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In some categories, eBay may also copy the EAN to the listing's item specifics.

The EAN of a product may be required for some categories, and not applicable to others. To see if the intended listing category supports or requires an EAN, use the GetCategoryFeatures call, passing in the category's ID in the CategoryID field, including the DetailLevel field in the request and setting it to 'ReturnAll', and including a FeatureID field in the request and setting it to 'EANEnabled'. Upon a successful call, look in the call response for the value in the Category.EANEnabled field (either 'Enabled', 'Disabled', or 'Required').

Note: If creating a multiple-variation listing, the EAN of each product variation should be specified in the VariationProductListingDetails container instead.

Note: If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
See the Field Index to learn which calls use EAN.

IncludePrefilledItemInformation ( boolean ) [0..1]
If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests.

For GetItem and related calls: The eBay site shows the catalog product description in the product details section of a listing. You cannot download this pre-filled description text via the API. To retrieve a URL for the catalog product details page, see DetailsURL in FindProducts in the Shopping API.
See the Field Index to learn which calls use IncludePrefilledItemInformation.

IncludeStockPhotoURL ( boolean ) [0..1]
When set to true in the Add/Relist/Revise calls, causes the stock photo of the item (if available) to be used in the listing. If UseStockPhotoURLAsGallery is also set to true, the stock photo will also be use as the Gallery image. When returned, indicates if the stock photo of the item was used.

Note: If you also include additional images with Item.PictureDetails.PictureURL, the View Item page will show only these images and the stock photo will not be shown.
If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). 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.

eBay selects a Gallery thumbnail from image URLs included in the request (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).

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.

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

ISBN ( string ) [0..1]
ISBN (International Standard Book Number) is a unique 10 or 13-character identifier for books. This value is used to match the product with a product in the eBay catalog and to pick up that product's item title, item description, item specifics, and stock photos. If you specify the 13-character ISBN, the value must begin with either 978 or 979. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In some categories, eBay may also copy the ISBN value to the listing's item specifics.

The ISBN of a product may be required for some categories, and not applicable to others. To see if the intended listing category supports or requires an ISBN, use the GetCategoryFeatures call, passing in the category's ID in the CategoryID field, including the DetailLevel field in the request and setting it to 'ReturnAll', and including a FeatureID field in the request and setting it to 'ISBNEnabled'. Upon a successful call, look in the call response for the value in the Category.ISBNEnabled field (either 'Enabled', 'Disabled', or 'Required').

Note: If creating a multiple-variation listing, the ISBN of each product variation should be specified in the VariationProductListingDetails container instead.

Note: If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
See the Field Index to learn which calls use ISBN.

ProductDetailsURL ( anyURI ) [0..1]
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. See Pre-filling Item Specifics with Product Details 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 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]
Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, BrandMPN, or 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 ProductID values. This lets you choose one of the ProductIDs 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 ProductID 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 to 'true'.
See the Field Index to learn which calls use StockPhotoURL.

TicketListingDetails ( TicketListingDetailsType ) [0..1]
Only applicable when you are listing event tickets. Only used to match catalog products when creating listings (not for buy-side searching).
See the Field Index to learn which calls use TicketListingDetails.

UPC ( string ) [0..1]
UPC (Universal Product Code) is a unique, 12-character identifier that many industries use to identify products. This value is used to match the product with a product in the eBay catalog and to pick up that product's item title, item description, item specifics, and stock photos.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In some categories, eBay may also copy the UPC value to the listing's item specifics.

The UPC of a product may be required for some categories, and not applicable to others. To see if the intended listing category supports or requires an UPC, use the GetCategoryFeatures call, passing in the category's ID in the CategoryID field, including the DetailLevel field in the request and setting it to 'ReturnAll', and including a FeatureID field in the request and setting it to 'UPCEnabled'. Upon a successful call, look in the call response for the value in the Category.UPCEnabled field (either 'Enabled', 'Disabled', or 'Required').

Note: If creating a multiple-variation listing, the UPC of each product variation should be specified in the VariationProductListingDetails container instead.

Note: If the listing is being posted to a category that expects a UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
See the Field Index to learn which calls use UPC.

UseFirstProduct ( boolean ) [0..1]
Indicates what eBay should do if more than one product in the eBay product catalog 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]
When set to true in the Add/Relist/Revise calls and IncludeStockPhotoURL is also set to true, causes the stock photo of the item (if available) to be used as the gallery thumbnail. When returned, indicates if the stock photo of the item was used.
See the Field Index to learn which calls use UseStockPhotoURLAsGallery.