--- name: metadata-api description: "Metadata API skill. Use when working with Metadata for marketplace, compatibilities, shipping. Covers 27 endpoints." version: 1.0.0 generator: lapsh --- # Metadata API API version: v1.12.1 ## Auth OAuth2 ## Base URL https://api.ebay.com/sell/metadata/v1 ## Setup 1. Configure auth: OAuth2 2. GET /marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies -- this method returns the ebay policies that define how to list automotive parts compatibility items in the categories of the specified marketplace. by default, this method returns all categories that support parts compatibility. you can limit the size of the result set by using the filter query parameter to specify only the category ids you want to review.note: to return policy information for the ebay us marketplace, specify ebay_motors_us as the path parameter for marketplace_id.tip: this method can potentially return a very large response payload. ebay recommends that the response payload be compressed by passing in the accept-encoding request header and setting the value to gzip.if you specify a valid marketplace id but that marketplace does not contain policy information, or if you filter out all results, a 204 no content status code is returned with an empty response body. 3. POST /compatibilities/get_compatibilities_by_specification -- create first get_compatibilities_by_specification ## Endpoints 27 endpoints across 4 groups. See references/api-spec.lap for full details. ### Marketplace | Method | Path | Description | |--------|------|-------------| | GET | /marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies | This method returns the eBay policies that define how to list automotive parts compatibility items in the categories of the specified marketplace. By default, this method returns all categories that support parts compatibility. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.Note: To return policy information for the eBay US marketplace, specify EBAY_MOTORS_US as the path parameter for marketplace_id.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a 204 No content status code is returned with an empty response body. | | GET | /marketplace/{marketplace_id}/get_category_policies | This method returns eBay category policy metadata for all leaf categories on the specified marketplace.By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body. | | GET | /marketplace/{marketplace_id}/get_classified_ad_policies | This method returns eBay classified ad policy metadata for all leaf categories on the specified marketplace.By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body.Note: This method does not support classified ads for eBay US Motors categories (EBAY_MOTORS_US). For eBay Motors Pro users, use getMotorsListingPolicies. | | GET | /marketplace/{marketplace_id}/get_currencies | This method returns the default currency used by the eBay marketplace specified in the request. This is the currency that the seller should use when providing price data for this marketplace through listing APIs. | | GET | /marketplace/{marketplace_id}/get_extended_producer_responsibility_policies | This method returns the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace.The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata on every applicable category for the specified marketplace.Note: Currently, the Extended Producer Responsibility policies are only applicable to a limited number of categories.Note: Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned. Instead, sellers will provide/manage these IDs at the account level by going to Account Settings.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_hazardous_materials_labels | This 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. The returned statements are localized for the default language of the marketplace. If a marketplace does not support hazardous materials label information, no response payload is returned, but only a 204 No content status code.This information is used by the seller to add hazardous materials label related information to their listings (see Specifying hazardous material related information). | | GET | /marketplace/{marketplace_id}/get_item_condition_policies | This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace. This metadata consists of the different item conditions (with IDs) that an eBay category supports, and a boolean to indicate if an eBay category requires an item condition. If applicable, this metadata also shows the different condition descriptors (with IDs) that an eBay category supports.Note: Currently, condition grading is only applicable to the following trading card categories: Non-Sport Trading Card SinglesCCG Individual CardsSports Trading Cards SinglesThe identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata on every single category for the specified marketplace. If you only want to view item condition metadata for one eBay category or a select group of eBay categories, you can pass in up to 50 eBay category ID through the filter query parameter.Important: Certified - Refurbished-eligible sellers, and sellers who are eligible to list with the new values (EXCELLENT_REFURBISHED, VERY_GOOD_REFURBISHED, and GOOD_REFURBISHED) must use an OAuth token created with the authorization code grant flow and https://api.ebay.com/oauth/api_scope/sell.inventory scope in order to retrieve the refurbished conditions for the relevant categories.Refurbished item conditions are only supported in the Australia, Canada, French Canada, Germany, France, Italy, UK, and US marketplaces. See the eBay Refurbished Program page in help center for the categories that support refurbished conditions. These restricted item conditions will not be returned if an OAuth token created with the client credentials grant flow and https://api.ebay.com/oauth/api_scope scope is used, or if any seller is not eligible to list with that item condition. See the Specifying OAuth scopes topic for more information about specifying scopes.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_listing_structure_policies | This method returns the eBay policies that define the allowed listing structures for the categories of a specific marketplace. The listing-structure policies currently pertain to whether or not you can list items with variations. By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_listing_type_policies | This method returns eBay listing type policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body. | | GET | /marketplace/{marketplace_id}/get_motors_listing_policies | This method returns eBay Motors policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body.Note: To return policy information for eBay US Motors categories, specify marketplace_id as EBAY_MOTORS_US. | | GET | /marketplace/{marketplace_id}/get_negotiated_price_policies | This method returns the eBay policies that define the supported negotiated price features (like "best offer") for the categories of a specific marketplace. By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_product_safety_labels | This method returns product safety label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available statements and pictograms. The returned statements are localized for the default language of the marketplace. If a marketplace does not support product safety label information, no response payload is returned, but only a 204 No content status code.This information is used by the seller to add product safety label related information to their listings. The getRegulatoryPolicies method can be used to see which categories recommend or require product safety labels. | | GET | /marketplace/{marketplace_id}/get_regulatory_policies | This method returns regulatory policies for one, multiple, or all eBay categories in an eBay marketplace. The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata for every listing category in the specified marketplace.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_return_policies | This method returns the eBay policies that define whether or not you must include a return policy for the items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and international return policies in the different eBay categories. By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip. | | GET | /marketplace/{marketplace_id}/get_shipping_policies | This method returns eBay shipping policy metadata for all leaf categories on the specified marketplace.By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body. | | GET | /marketplace/{marketplace_id}/get_site_visibility_policies | This method returns eBay international site visibility policy metadata for all leaf categories on the specified marketplace.By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body. | ### Compatibilities | Method | Path | Description | |--------|------|-------------| | POST | /compatibilities/get_compatibilities_by_specification | This method is used to retrieve all compatible application name-value pairs for a part based on the provided specification(s).The part's relevant dimensions and/or characteristics can be provided through the specifications container. For example, when retrieving compatible application name-value pairs for a tire, the tire's dimensions (such as the section width or rim diameter) should be provided.By default, all compatible application name-value pairs for the specifications are returned. You can limit the size of the result set by using the compatibilityPropertyFilters array to specify the properties (such as make, model, year, or trim) you wish to be included in the response.Note: The getCompatibilityPropertyNames and getCompatibilityPropertyValues methods can be used to retrieve valid property names and values that can be used as the name-value pairs to define specifications. | | POST | /compatibilities/get_compatibility_property_names | This method is used to retrieve product compatibility property names for the specified compatibility-enabled category.Compatibility property names can be used alongside the corresponding compatibility property value (retrieved using the getCompatibilityPropertyValues method) to describe the assembly for which an item is compatible.The categoryId of the compatibility-enabled category for which to retrieve compatibility property names is required in the request body.By default, all property names within the compatibility category of the specified compatibility-enable category are returned. You can limit the size of the result set by using the dataset array to specify the types of properties you want returned. | | POST | /compatibilities/get_compatibility_property_values | This method is used to retrieve product compatibility property values associated with a single property name, in the specified category.Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the getCompatibilityPropertyNames method) to describe the assembly for which an item is compatible.The categoryId of the compatibility-enabled category for which to retrieve compatibility property values is required in the request body, as well as the propertyName for which you wish to retrieve associated values.By default, all property values associated with the specified propertyName are returned. You can limit the size of the result set by using the propertyFilter array. Only property values associated with the specified name-value pairs will be returned. | | POST | /compatibilities/get_multi_compatibility_property_values | This method is used to retrieve product compatibility property values associated with multiple property names, in the specified category.Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the getCompatibilityPropertyNames method) to describe the assembly for which an item is compatible.The categoryId of the compatibility-enabled category for which to retrieve compatibility property values is required in the request body, as well as the propertyNames for which you wish to retrieve associated property values. The propertyFilter array is also required to constrain the output. Only property values associated with the specified name-value pairs will be returned. | | POST | /compatibilities/get_product_compatibilities | This method is used to retrieve all available item compatibility details for the specified product.Item compatibility details can be used to see the properties for which an item is compatible. For example, if you are searching for a part for a specific vehicle, you can use this method to see the years, engine, and/or trim for which the part is compatible. Item compatibility details are returned as name-value pairs.The product for which to retrieve item compatibility details must be provided through the productIdentifier field. This value can be either an eBay specific identifier (such as an ePID) or an external identifier (such as a UPC).By default, all available item compatibility details for the specified product are returned. You can limit the size of the result set using the dataset or datasetPropertyName fields to specify the types of properties you want returned in the response. The applicationPropertyFilter array can also be used so that only parts compatible with the specified name-value pairs are returned. | ### Shipping | Method | Path | Description | |--------|------|-------------| | GET | /shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations | This method retrieves a list of locations that the seller can use as excluded shipping locations within their listings or in their fulfillment business policies for the specified marketplace. These are locations that a seller designates as areas where they will not ship items. Excluded shipping locations and ship-to locations are used in tandem at the listing level and in fulfillment business policies. Excluded shipping locations and ship-to locations share a lot of the same values and they should not contradict each other.Manage excluded shipping locations using business policies through the fulfillment_policy resource of the Account v1 API. | | GET | /shipping/marketplace/{marketplace_id}/get_handling_times | This method retrieves a list of supported handling times for the specified marketplace. The handling time returned specifies the maximum number of business days the eBay site allows for shipping an item to domestic buyers after receiving a cleared payment. Handling times apply to both domestic and international orders. If the handling time is 1 day, the seller commits to dropping the item off for shipment one business day after payment clears. Manage handing times using business policies through the fulfillment_policy resource of the Account v1 API. | | GET | /shipping/marketplace/{marketplace_id}/get_shipping_carriers | This method retrieves a list of supported shipping carriers for the specified marketplace. It provides essential information for sellers to understand which shipping carriers are available for use when listing items on that eBay marketplace. Knowing the supported carriers can help sellers optimize their shipping options and ensure efficient delivery to buyers.The value returned in the shippingCarrier field is the enumerated value required when providing shipment tracking information for that carrier.Tip: Use the getShippingServices method to explore available shipping services for each carrier.Manage shipping carriers using business policies through the fulfillment_policy resource of the Account v1 API. | | GET | /shipping/marketplace/{marketplace_id}/get_shipping_locations | This method retrieves a list of supported shipping locations for the specified marketplace. It provides sellers with information on where they can ship their items. Sellers can use this information to configure their shipping settings. Tip: Use the getExcludeShippingLocations method to return locations where the seller does not ship.Manage shipping locations using business policies through the fulfillment_policy resource of the Account v1 API. | | GET | /shipping/marketplace/{marketplace_id}/get_shipping_services | This method retrieves a list of shipping services supported for the specified marketplace, including valid shipping services, shipping times, and package constraints such as size and weight.Manage shipping services using business policies through the fulfillment_policy resource of the Account v1 API. | ### Country | Method | Path | Description | |--------|------|-------------| | GET | /country/{countryCode}/sales_tax_jurisdiction | This method retrieves all sales-tax jurisdictions for the country specified in the countryCode path parameter. Countries with valid sales-tax jurisdictions are Canada and the US.The response from this call tells you the jurisdictions for which a seller can configure tax tables. Although setting up tax tables is optional, you can use the createOrReplaceSalesTax method in the Account API call to configure the tax tables for the jurisdictions into which you sell.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "List all get_automotive_parts_compatibility_policies?" -> GET /marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies - "List all get_category_policies?" -> GET /marketplace/{marketplace_id}/get_category_policies - "List all get_classified_ad_policies?" -> GET /marketplace/{marketplace_id}/get_classified_ad_policies - "List all get_currencies?" -> GET /marketplace/{marketplace_id}/get_currencies - "List all get_extended_producer_responsibility_policies?" -> GET /marketplace/{marketplace_id}/get_extended_producer_responsibility_policies - "List all get_hazardous_materials_labels?" -> GET /marketplace/{marketplace_id}/get_hazardous_materials_labels - "List all get_item_condition_policies?" -> GET /marketplace/{marketplace_id}/get_item_condition_policies - "List all get_listing_structure_policies?" -> GET /marketplace/{marketplace_id}/get_listing_structure_policies - "List all get_listing_type_policies?" -> GET /marketplace/{marketplace_id}/get_listing_type_policies - "List all get_motors_listing_policies?" -> GET /marketplace/{marketplace_id}/get_motors_listing_policies - "List all get_negotiated_price_policies?" -> GET /marketplace/{marketplace_id}/get_negotiated_price_policies - "List all get_product_safety_labels?" -> GET /marketplace/{marketplace_id}/get_product_safety_labels - "List all get_regulatory_policies?" -> GET /marketplace/{marketplace_id}/get_regulatory_policies - "List all get_return_policies?" -> GET /marketplace/{marketplace_id}/get_return_policies - "List all get_shipping_policies?" -> GET /marketplace/{marketplace_id}/get_shipping_policies - "List all get_site_visibility_policies?" -> GET /marketplace/{marketplace_id}/get_site_visibility_policies - "Create a get_compatibilities_by_specification?" -> POST /compatibilities/get_compatibilities_by_specification - "Create a get_compatibility_property_name?" -> POST /compatibilities/get_compatibility_property_names - "Create a get_compatibility_property_value?" -> POST /compatibilities/get_compatibility_property_values - "Create a get_multi_compatibility_property_value?" -> POST /compatibilities/get_multi_compatibility_property_values - "Create a get_product_compatibility?" -> POST /compatibilities/get_product_compatibilities - "List all get_exclude_shipping_locations?" -> GET /shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations - "List all get_handling_times?" -> GET /shipping/marketplace/{marketplace_id}/get_handling_times - "List all get_shipping_carriers?" -> GET /shipping/marketplace/{marketplace_id}/get_shipping_carriers - "List all get_shipping_locations?" -> GET /shipping/marketplace/{marketplace_id}/get_shipping_locations - "List all get_shipping_services?" -> GET /shipping/marketplace/{marketplace_id}/get_shipping_services - "List all sales_tax_jurisdiction?" -> GET /country/{countryCode}/sales_tax_jurisdiction - "How to authenticate?" -> See Auth section above ## Response Tips - Check response schemas in references/api-spec.lap for field details - Create/update endpoints return the modified resource on success - Error responses include status codes and descriptions in the spec ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)