Skip to main content

Just getting started with the Metadata API? See the following documents for details on using this API:

Announcements

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

The API release history

The following table lists the releases for the Metadata API:

Version Release Date Summary of Release

Version 1.9.0

2024-12-18

A new resource, compatibility,has been added, with five new methods to support parts compatibility features
Version 1.8.0 2024-07-09 Two methods were added to the marketplace resource: getProductSafetyLabels and getRegulatoryPolicies
Version 1.7.1 2023-08-29 In getExtendedProducerResponsibilityPolicies the Extended Producer Responsibility fields are now supported on all marketplaces.
Version 1.7.0 2023-06-26 Expanded response payload for getItemConditionPolicies to support condition grading related information.
Version 1.6.1 2023-06-22 Extended Producer Responsibility IDs are no longer set at the listing level.
Version 1.6.0 2023-01-09 New Schema added to support hazardous material labels related information and repair score index
Version 1.5.0 2021-12-13 One new method was added to the marketplace resource: getExtendedProducerResponsibilityPolicies
Version 1.4.3 2021-11-30 The getProductAdoptionPolicies method was removed from the API.
Version 1.4.2 2021-09-01 A usage field was added under the itemConditions container to indicate item conditions that are only available for use by eligible sellers
Version 1.4.1 2021-06-22 Expanded marketplace support for the marketplace resource
Version 1.4.0 2021-03-24 Enhanced the getItemConditionPolicies method to return the Certified Refurbished item condition for sellers who are eligible to list with that item condition
Version 1.3.0 2018-10-15 Expanded response payload for getReturnPolicies
Version 1.2.0 2018-05-15 One new method added to the marketplace resource: getProductAdoptionPolicies
Version 1.1.0 2017-06-06 Five new methods added to the marketplace resource
Version 1.0.0 2016-10-19 Initial release of Version 1

Version 1.9.0

The following section details the updates that have been made for 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: 

Version 1.8.0

The following section details the updates that have been made for 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.

Version 1.7.1

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.

Note: Currently, the Extended Producer Responsibility policies are only applicable to a limited number of categories.

Version 1.7.0

The following section details the updates that have been made for 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.

Note: Condition grading is currently only available for the following trading card categories:

  • Non-Sport Trading Card Singles
  • CCG Individual Cards
  • Sports Trading Card Singles

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.

Version 1.6.1

The following section details the updates that have been made for 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.

Version 1.6.0

The following section details the updates that have been made for 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:

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.

Version 1.5.0

The following section details the updates that have been made for 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.

Note: The Extended Producer Responsibility policies are currently only applicable to a limited number of categories, and only in the EBAY_FR marketplace.

Version 1.4.3

The following section details the updates that have been made for 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.

Version 1.4.2

The following section details the updates that have been made for 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)

Note: ConditionIds 2010, 2020, and 2030 apply only to the category Cell Phones & Smartphones - 9355.

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

Version 1.4.1

The following section details the updates that have been made for 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)

Tip: Refer to the Metadata API overview for a full list of supported marketplaces and locales.

Version 1.4.0

The following sections detail the updates that have been made for 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.

Version 1.3.0

The following sections detail the updates that have been made for 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.

Version 1.2.0

The following sections detail the updates that have been made for this release.

New methods

This release adds one new method to marketplace resource:

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.

Version 1.1.0

This release introduces five new methods in the new marketplace resource.

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

Version 1.0.0

This is the initial release of the Metadata API, Version 1.

For a list of resources and methods, see the Metadata API Reference.