This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog. If a product match is found, the inventory item record will automatically pick up all product details associated with the eBay Catalog product. Note: For the US, UK, CA (English), and AU sites, eBay is starting to require that some products in certain eBay categories be associated with an eBay Catalog product. For more information on this requirement, see the Product-Based Shopping Experience Playbook topic in the Selling Integration Guide. In an attempt to find a eBay Catalog product match, an ePID value is always preferred over the other product identifiers, since it is possible that one GTIN value can be associated with multiple eBay Catalog products, and if multiple products are found, product details will not be picked up by the Inventory Item object.
Many eBay categories do not require listings to be associated with an eBay Catalog product, but will require at least one product identifier (a GTIN or a Brand/MPN pair). To discover which product identifier(s) that an eBay category requires or supports, use the GetCategoryFeatures
call in the Trading API. In the call request, include four FeatureID
fields and set the values in those fields to
. In the call response, look for these same field names under the Category
node. The values returned in the EANEnabled
fields will either be
(GTIN type is supported but not required),
(GTIN type must be supplied for the inventory item), or
(GTIN type is not supported for the category). The BrandMPNIdentifierEnabled
is a boolean field, and a
value indicates that the seller must supply brand
values. Ideally, if a GTIN type or Brand/MPN pair is required/supported and is known by the seller, these product identifiers should be supplied for the inventory item. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the GeteBayDetails
call of the Trading API to get this string value. In the GeteBayDetails
call, the seller should include a DetailName
field with its value set to
. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText
field. The seller will use this value in one or more of the product identifier fields (ean
, or mpn
) if a product ID isn't known or applicable.
This container is not initially required, but it is required before an inventory item can be published as an offer, and/or if an inventory item is being updated and product data already exists for that inventory item.
This container is always returned for published offers in the getInventoryItem
, and getInventoryItems
calls since product data must be defined for published offers, but for unpublished inventory items, this container will only be returned if product details have been defined for the inventory item.