eBay Trading APIVersion 1055

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 Item Number (EAN, ISBN, or UPC) or an eBay Product ID (e.g. 'ePID'). If a specified product identifier is matched to a product in the eBay catalog, some of the details for the product listing, such as product title, product description, item specifics, and stock photo are prefilled for the listing.

Note: If a Brand/MPN pair is required for the product, these values must still be input through the BrandMPN container, but a catalog product match is only possible with an ePID or one of the GTINs.

Type that uses ProductListingDetailsType:

Calls that use ProductListingDetailsType:

Fields



BrandMPN ( BrandMPNType ) [0..1]
This container is used if the seller wants to, or is required to identify a product using an Brand/Manufacturer Part Number (MPN) pair. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if a Brand/MPN pair is supported/required for a category. Both the Brand and MPN fields are required if the category/product requires an MPN value.

Unlike the GTIN types (e.g. EAN, ISBN, or UPC), a Brand/MPN pair cannot be used to find an eBay catalog product match. So, in order to find a catalog product match, either an ePID or a GTIN value must also be provided through the ProductListingDetails container.

This container is only applicable for single-variation listings. For multiple-variation listings, if the category requires Brand/MPN pairs, the product brand (shared by all variations in this listing) is passed in through the item-level item specifics (Item.ItemSpecifics.NameValueList), and the MPN value for each variation in the listing is passed in through the variation-level item specifics (Variation.VariationSpecifics.NameValueList).

Note: If the listing is being posted to a category that expects a MPN 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 BrandMPN.

Copyright ( string ) [0..*]
Copyright statement indicating the source of the product information. This information will be included in the listing if the seller used an eBay catalog product to list the item.
See the Field Index to learn which calls use Copyright.

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

This field is no longer applicable and should not be used.
See the Field Index to learn which calls use DetailsURL.

EAN ( string ) [0..1]
This field is used if the seller wants to, or is required to identify a product using an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if an EAN is supported/required for a category.

If the IncludeeBayProductDetails field is omitted or included and set to true, eBay will use the EAN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.

This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an EAN value, this value should be passed into the Variation.VariationProductListingDetails.EAN field 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.

IncludeeBayProductDetails ( boolean ) [0..1]
This boolean field controls whether or not an eBay catalog product is used to create or revise a listing. If an ePID or GTIN 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 catalog, and then automatically create/revise the listing using the product title, product description, item specifics, and stock photo defined for the catalog product.

If the seller wants to use an eBay catalog product to create/revise a 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 use an eBay catalog product to create/revise their listing, this field should be included and set to false. If the seller declines to use an eBay catalog product, they will be required to pass in their own listing title, listing description, item specifics, a listing category, and at least one picture.

Note: For categories/product brands that are part of the Product-Based Commerce mandate, setting this field to false will cause the call to fail, as a eBay catalog product is required for category/brands that are part of the mandate. For more information on the Product-Based Commerce mandate and the categories/product brands affected by this project, see the Product-Based Shopping Experience Playbook.
See the Field Index to learn which calls use IncludeeBayProductDetails.

IncludeStockPhotoURL ( boolean ) [0..1]
If this value is true, the listing will use the eBay catalog product's stock photo. In an Add/Revise/Relist call, this field is set to true by default. If you will be using an eBay catalog product to list your item, it is always advised to include the stock photo. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields. Seller photos are particularly recommended for used and modified products to give prospective buyers a clear sense of exactly what they are purchasing. In GetItem and other 'Get' calls, the URL of the stock photo will be returned in the StockPhotoURL field.

Note: For categories/product brands that are part of the Product-Based Commerce mandate, setting this field to false may cause the call to fail. For more information on the Product-Based Commerce mandate and the categories/product brands affected by this project, see the Product-Based Shopping Experience Playbook.
See the Field Index to learn which calls use IncludeStockPhotoURL.

ISBN ( string ) [0..1]
This field is used if the seller wants to, or is required to identify a product using an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if an ISBN is supported/required for a category.

If the IncludeeBayProductDetails field is omitted or included and set to true, eBay will use the ISBN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.

This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an ISBN value, this value should be passed into the Variation.VariationProductListingDetails.ISBN field 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.

NameValueList ( NameValueListType ) [0..*]
Not used by any call.

This container is for future use. If it used, it will be ignored.
See the Field Index to learn which calls use NameValueList.

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

This field is no longer applicable and should not be used.
See the Field Index to learn which calls use ProductDetailsURL.

ProductReferenceID ( string ) [0..1]
In an Add/Revise/Relist call, this field is used to pass in the eBay Product ID (e.g. ePID), which is the unique identifier of the eBay catalog product. Although an eBay catalog product match can be found using one or more GTIN values, passing in an ePID value is the best way to try and discover the appropriate eBay catalog product. For more information on finding a product in the eBay catalog, see the Product-Based Shopping Experience Playbook.
See the Field Index to learn which calls use ProductReferenceID.

ReturnSearchResultOnDuplicates ( boolean ) [0..1]
If the seller attempts to use ProductListingDetails in an Add/Revise/Relist call to find an eBay catalog product match, and multiple matches are found, the call will actually fail. This field can be included and set to true if the seller wants to see the eBay catalog products that were found through error messages in the call response. This flag will not have an effect if only one catalog product matchi is found, or if the UseFirstProduct field is used and set to true and a catalog product is found to create/revise the listing.

If this field is omitted or set to false, and multiple catalog products are found, the call will fail and no information about the matching catalog products will be returned.
See the Field Index to learn which calls use ReturnSearchResultOnDuplicates.

StockPhotoURL ( anyURI ) [0..1]
The full URL for the eBay catalog product's stock photo. This field is only returned if the seller used an eBay catalog product to list the item, and the IncludeStockPhotoURL field was set to true.
See the Field Index to learn which calls use StockPhotoURL.

TicketListingDetails ( TicketListingDetailsType ) [0..1]
This container is only applicable when a seller is creating/revising an event tickets listing.
See the Field Index to learn which calls use TicketListingDetails.

UPC ( string ) [0..1]
This field is used if the seller wants to, or is required to identify a product using a UPC (Universal Product Code) value. A UPC is a commonly used identifer for many different products. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if a UPC is supported/required for a category.

If the IncludeeBayProductDetails field is omitted or included and set to true, eBay will use the UPC value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.

This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires a UPC value, this value should be passed into the Variation.VariationProductListingDetails.UPC field 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]
This field can be included and set to true if the seller wants to use the first eBay catalog product that is found to create/revise the listing. eBay will search for an eBay catalog product match if the seller provides an ePID or one or more GTIN values. If this field is omitted, or included and set to false, the call will fail if more than one eBay catalog product is found.
See the Field Index to learn which calls use UseFirstProduct.

UseStockPhotoURLAsGallery ( boolean ) [0..1]
If this value is true, the listing will use the eBay catalog product's stock photo as the Gallery thumbnail photo. In an Add/Revise/Relist call, this field is set to true by default. If this field is set to true, the IncludeStockPhotoURL field must also be set to true or this field will have no effect. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields, but none of these photos will be the Gallery thumbnail photo.

Note: For categories/product brands that are part of the Product-Based Commerce mandate, setting this field to false may cause the call to fail. For more information on the Product-Based Commerce mandate and the categories/product brands affected by this project, see the Product-Based Shopping Experience Playbook.
See the Field Index to learn which calls use UseStockPhotoURLAsGallery.