Metadata API Release Notes

1.13.1

The following changes have been made in this release.

Support for condition grading related information expanded

Sellers now have the ability to provide condition grading related information for items in the following coin categories. The condition descriptors that an eBay category supports can be returned using the getItemConditionPolicies method.

• Coins: US

• Coins: World

• Coins: Canada

• Coins: Ancient

• Coins: Medieval

1.13.0

The following changes have been made in this release.

New method added

This release adds a new endpoint to the marketplace resource. The getMinimumListingPricePolicies method returns minimum listing price policies for supported types of listings on a specific marketplace.

1.12.1

The following changes have been made in this release.

In this release, the getCategoryPolicies response includes a new field: reservePriceAllowed. This boolean indicates whether auction listings in a given category may use a reserve price.

1.12.0

The following changes have been made in this release.

New methods

This following new methods were added: 

• getExcludeShippingLocations: Returns excluded shipping locations available for the specified marketplace.
• getHandlingTimes: Returns supported handling times for the specified marketplace.
• getShippingCarriers: Returns supported shipping carriers for the specified marketplace.
• getShippingLocations: Returns supported shipping locations for the specified marketplace.
• getShippingServices: Returns supported shipping services for the specified marketplace.

1.11.1

The following changes have been made in this release.

Schema changes

In this release, the valueCategory boolean has been added to the categoryPolicies container of the getCategoryPolicies response. If returned as true, this boolean indicates that the leaf category for the specified site is designated by eBay as a value category. Value categories can be used as a secondary category for a listing at no extra charge.

1.11.0

The following changes have been made in this release.

Schema changes

The getCurrencies method that supports currency metadata was added to the marketplace resource. This method returns the default currency supported by the eBay system for the site specified in the request.

The getCategoryPolicies method now supports Global Trade Item Numbers (GTINs) metadata by adding three fields to the get_category_policies resource:

• eanSupport: Indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category.

• isbnSupport: Indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the specified category.

• upcSupport: Indicates whether or not the category on the specified eBay site supports the use of Universal Product Codes (UPCs) to help create a listing.

To support these fields, the enumerated type ProductIdentiferEnabledEnum was added. This type contains values to indicate whether or not the feature can be used or not, or is required or not.

The getMotorsListingPolicies method now provides additional compatibility metadata through two fields in the get_motors_listing_policies resource.

• kTypeSupported: Indicates the category supports the use of a K Type to identify the cars and trucks compatible with a motor vehicle part or accessory. Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K Types.

• minItemCompatibility: Indicates the minimum number of required compatible applications for listing items.

1.10.0

The following changes have been made in this release.

Support for leaf category metadata added

This release adds support for that allows sellers to retrieve leaf category metadata for a site.

New methods

This release adds the following methods to the marketplace resource: 

• getCategoryPolicies: Retrieves eBay category policy metadata for a specified marketplace.

• getClassifiedAdPolicies: Retrieves eBay classified ad policy metadata for a specified marketplace.

• getListingTypePolicies: Retrieves eBay listing type policy metadata for a specified marketplace.

• getMotorsListingPolicies: Retrieves eBay Motors policy metadata for a specified marketplace.

• getShippingPolicies: Retrieves eBay shipping policy metadata for a specified marketplace.

• getSiteVisibilityPolicies: Retrieves eBay international site visibility policy metadata for a specified marketplace.

1.9.0

The following changes have been made in this release.

Support for compatibility search

This release adds a new resource, compatibility, that allows sellers to retrieve part compatibility details for a specific category, or for a specific product.

New methods

This release adds the following methods to the compatibility resource: 

• getCompatibilitiesBySpecification: Find compatible applications for a part based on provided specifications.

• getCompatibilityPropertyNames: Retrieve product compatibility property names for the specified category.

• getCompatibilityPropertyValues: Retrieve product compatibility property values associated with a property name.

• getMultiCompatibilityPropertyValues: Retrieve product compatibility property values associated with a property names.

• getProductCompatibilities: Retrieve all available item compatibility details for a specified product.

1.8.0

The following changes have been made in this release.

Two methods added

This release adds two new endpoints to the marketplace resource. The getProductSafetyLabels method retrieves available product safety label information for a given eBay marketplace. The getRegulatoryPolicies method allows users to retrieve all eBay categories that support/require regulatory policies data for a given eBay marketplace.

1.7.1

The following changes have been made in this release.

The following section details the update that has been made for this release.

In getExtendedProducerResponsibilityPolicies method the Extended Producer Responsibility fields are now supported on all marketplaces. The following content is changed.

1.7.0

The following changes have been made in this release.

Support for condition grading related information added

Sellers now have the ability to provide condition grading related information for items in applicable categories. The condition descriptors that an eBay category supports can be returned using the getItemConditionPolicies method.

Schema changes

The following container and its child fields are now available in the getItemConditionPolicies response payload:

• conditionDescriptors - This container holds the information relating to condition descriptors and condition descriptor values for the specified category or categories.

1.6.1

The following changes have been made in this release.

Extended Producer Responsibility IDs

Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned for PRODUCER_PRODUCT_ID, PRODUCT_DOCUMENTATION_ID, PRODUCT_PACKAGE_ID, and SHIPMENT_PACKAGE_ID. Sellers will provide/manage these IDs at the account level by going to Account Settings. These enumerated values were returned in the ExtendedProducerResponsibilityEnum type.

1.6.0

The following changes have been made in this release.

Support for hazardous material labels related information added

Due to regulatory requirement changes, sellers now have the ability to provide hazardous material related information.

New methods

This release adds the getHazardousMaterialsLabels method to marketplace resource:

• For the specified marketplace, retrieves the available hazardous materials label information:
    GET /marketplace/{marketplaceId}/get_hazardous_materials_labels

This new method returns hazardous materials label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available signal words, statements, and pictograms.

Schema changes

The following containers and their child fields are available in the getHazardousMaterialsLabels response:

• signalWords - This container consists of available signal words for hazardous materials for the specified marketplace.
• statements - This container consists of available hazard statements for the specified marketplace.
• pictograms - This container consists of available hazard pictograms for the specified marketplace.

Support for repair score index added

eBay is required to provide sellers the ability to specify the repair score index in certain categories and if the attribute is RECOMMENDED or REQUIRED. The repair score index describes how easy is it to repair the product.

Schema changes

The following enumerated values have been added to the getExtendedProducerResponsibilityPolicies response through extendedProducerResponsibilities.supportedAttributes:

• REPAIR_SCORE - This enum value is used to identify the repair score attribute. Available through the name field.
• RECOMMENDED - This enum value indicates that the attribute is recommended. Available through the usage field.

1.5.0

The following changes have been made in this release.

New method added

This release adds a new endpoint to the marketplace resource. The getExtendedProducerResponsibilityPolicies method allows users to retrieve the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace.

1.4.3

The following changes have been made in this release.

getProductAdoptionPolicies method removed

The getProductAdoptionPolicies method was removed from the API. No eBay categories require that a listing be created using an eBay catalog product, so this method is no longer applicable.

1.4.2

The following changes have been made in this release.

Field "usage" added to "itemConditions" container

The usage field indicates item conditions that are only available for use by eligible sellers. The field has a single value, RESTRICTED.

usage:RESTRICTED conditionIds include:

• ConditionId 2000 (CERTIFIED_REFURBISHED)
• ConditionId 2010 (EXCELLENT_REFURBISHED)
• ConditionId 2020 (VERY_GOOD_REFURBISHED)
• ConditionId 2030 (GOOD_REFURBISHED)

For a description of each condition ID, refer to Item condition ID and name values.

1.4.1

The following changes have been made in this release.

New marketplace support

This release expands the marketplace support for the marketplace resource. The marketplace resource methods now support the following marketplaces and locales:

• EBAY_CA (fr-CA)
• EBAY_BE (fr-BE)
• EBAY_BE (nl-BE)

1.4.0

The following changes have been made in this release.

Schema changes

The https://api.ebay.com/oauth/api_scope/sell.inventory scope was added to the getItemConditionPolicies method.

New Features

The getItemConditionPolicies method has been enhanced to retrieve the Certified Refurbished item condition (Condition ID 2000). For this item condition to be returned by the applicable categories, the seller must be eligible to list with the Certified Refurbished item condition, they must use a an OAuth token created with the authorization code grant flow and https://api.ebay.com/oauth/api_scope/sell.inventory scope. See the getItemConditionPolicies reference document for more information.

1.3.0

The following changes have been made in this release.

Schema changes

This release adds new response fields to the getReturnPolicies method. The response payload now includes the domestic and international complex fields which provide the guidelines for configuring domestic and international return policies for each eBay category. The new domestic and international fields each include the following policy fields:

• policyDescriptionEnabled - A Boolean value that indicates whether or not a seller can populate the returnInstructions field for the associated return policy.
• refundMethods - Defines the allowable refund methods.
• returnMethods - Defines the allowable return methods.
• returnPeriods - Defines the allowable periods of time you can configure for the time the buyer has to return an item.
• returnsAcceptanceEnabled - Defines whether or not a seller accepts returns. While not endorsed by eBay, not accepting a return is a valid return policy.
• returnShippingCostPayers - Defines the allowable values for specifying who pays for the return shipping (SELLER or BUYER). Note that the return shipping for SNAD-related items must always be paid for by the seller.

1.2.0

The following changes have been made in this release.

New method

This release adds one new method to marketplace resource:

• For the specified marketplace, retrieves the list of categories that require items to be listed with an ePID value: GET /marketplace/{marketplaceId}/get_product_adoption_policies

This new method returns a list of leaf categories from the category tree of the specified marketplace. Each node in the response shows the policies that govern whether or not items listed in that category require an ePID value in their item descriptions. If productRequired equals true, then that category is governed by the product-adoption policies and you must include an ePID value in the body of any items you list in that category.

1.1.0

The following changes have been made in this release.

API updates

This release contains several new methods that let you retrieve specific listing policies for a specified eBay marketplace. You can filter the response by category IDs:

New methods

• Retrieve automotive-parts-comaptibility policies:
    GET /marketplace/{marketplaceId}/get_automotive_parts_compatibility_policies
• Retrieve item-condition policies:
    GET /marketplace/{marketplaceId}/get_item_condition_policies
• Retrieve listing-structure policies:
    GET /marketplace/{marketplaceId}/get_listing_structure_policies
• Retrieve negotiated-price policies:
    GET /marketplace/{marketplaceId}/get_negotiated_price_policies
• Retrieve return policies:
    GET /marketplace/{marketplaceId}/get_return_policies

1.0.0

The following changes have been made in this release.