{ "openapi": "3.0.0", "info": { "title": "Metadata API", "description": "The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces. In addition to marketplace information, the API also has operations that get information that helps sellers list items on eBay.", "contact": { "name": "eBay Inc," }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "v1.12.1" }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/metadata/v1" } } } ], "paths": { "/marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getAutomotivePartsCompatibilityPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. Use the Taxonomy API to retrieve category ID values.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{183521|183523|183524}

Note: URL-encoding of the parameter list is no longer required.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

Note: Only the following eBay marketplaces support automotive parts compatibility: ", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomotivePartsCompatibilityPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_category_policies": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getCategoryPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_classified_ad_policies": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getClassifiedAdPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example:filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See MarketplaceIdEnum for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifiedAdPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_currencies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getCurrencies", "parameters": [ { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which currency information is retrieved.

See the MarketplaceIdEnum type for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada and French Belgium marketplaces.

Follow the instructions below to retrieve metadata for these marketplaces:", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCurrenciesResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_extended_producer_responsibility_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getExtendedProducerResponsibilityPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree that should be returned.

When a categoryId value is specified, the returned category tree includes the policies for that parent node, as well as the policies for any child nodes below that parent node.

Pass in the categoryId values using a URL-encoded, pipe-separated ('|') list. For example:

filter=categoryIds%3A%7B100%7C101%7C102%7D

Maximum: 50", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information shall be retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedProducerResponsibilityPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_hazardous_materials_labels": { "get": { "tags": [ "marketplace" ], "description": "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).

", "operationId": "getHazardousMaterialsLabels", "parameters": [ { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which hazardous materials label information shall be retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HazardousMaterialDetailsResponse" } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_item_condition_policies": { "get": { "tags": [ "marketplace" ], "description": "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:
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 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.", "operationId": "getItemConditionPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned.

When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{100|101|102}

Note that you must URL-encode the parameter list, which results in the following filter for the above example:

  filter=categoryIds%3A%7B100%7C101%7C102%7D", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemConditionPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope", "https://api.ebay.com/oauth/api_scope/sell.inventory" ] } ] } }, "/marketplace/{marketplace_id}/get_listing_structure_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getListingStructurePolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned.

When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{100|101|102}

Note that you must URL-encode the parameter list, which results in the following filter for the above example:

  filter=categoryIds%3A%7B100%7C101%7C102%7D", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingStructurePolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_listing_type_policies": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getListingTypePolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingTypePoliciesResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_motors_listing_policies": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getMotorsListingPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotorsListingPoliciesResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_negotiated_price_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getNegotiatedPricePolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned.

When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{100|101|102}

Note that you must URL-encode the parameter list, which results in the following filter for the above example:

  filter=categoryIds%3A%7B100%7C101%7C102%7D", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NegotiatedPricePolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_product_safety_labels": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getProductSafetyLabels", "parameters": [ { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values. See the following note for exceptions.Note: This method is not supported in the EBAY_HK, EBAY_MY, EBAY_TW, or EBAY_PH marketplaces.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSafetyLabelsResponse" } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_regulatory_policies": { "get": { "tags": [ "marketplace" ], "description": "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.

", "operationId": "getRegulatoryPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree that should be returned.

Pass in the categoryId values using a URL-encoded, pipe-separated ('|') list. For example:

filter=categoryIds%3A%7B100%7C101%7C102%7D

Maximum: 50", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information shall be retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.Note: This method is not supported in the EBAY_HK, EBAY_MY, EBAY_TW, or EBAY_PH marketplaces.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryPolicyResponse" } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." }, "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46005": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_return_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getReturnPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned.

When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{100|101|102}

Note that you must URL-encode the parameter list, which results in the following filter for the above example:

  filter=categoryIds%3A%7B100%7C101%7C102%7D", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnPolicyResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only 50 Category IDs specified in the filter are considered." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_shipping_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getShippingPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:

Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingPoliciesResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/marketplace/{marketplace_id}/get_site_visibility_policies": { "get": { "tags": [ "marketplace" ], "description": "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.", "operationId": "getSiteVisibilityPolicies", "parameters": [ { "name": "filter", "in": "query", "description": "This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a \"leafCategory\": true tag.

The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example:filter=categoryIds:{3767|171784}", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:

Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteVisibilityPoliciesResponse" } } }, "x-response-codes": { "errors": { "46002": { "domain": "API_METADATA", "category": "REQUEST", "description": "The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}." }, "46003": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified categoryId was not found for the marketplace." }, "46004": { "domain": "API_METADATA", "category": "REQUEST", "description": "Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter." } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process.Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/compatibilities/get_compatibilities_by_specification": { "post": { "tags": [ "compatibilities" ], "description": "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.", "operationId": "getCompatibilitiesBySpecification", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "This type defines the properties and specifications to use to search for compatibilities.", "content": { "application/json": { "schema": { "description": "This type defines the properties and specifications to use to search for compatibilities.", "$ref": "#/components/schemas/SpecificationRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecificationResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "47000": { "domain": "API", "category": "REQUEST", "description": "Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter." }, "47002": { "domain": "API", "category": "REQUEST", "description": "The category {{category_id}} specified in the request does not support compatibilities." }, "47003": { "domain": "API", "category": "REQUEST", "description": "A required field is missing from the request." }, "47004": { "domain": "API", "category": "REQUEST", "description": "Invalid data supplied in the request." }, "47005": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request is invalid." }, "47006": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request does not support compatibility." } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/compatibilities/get_compatibility_property_names": { "post": { "tags": [ "compatibilities" ], "description": "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.", "operationId": "getCompatibilityPropertyNames", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "This type defines the properties used to retrieve compatibility property names.", "content": { "application/json": { "schema": { "description": "This type defines the properties used to retrieve compatibility property names.", "$ref": "#/components/schemas/PropertyNamesRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyNamesResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "47000": { "domain": "API", "category": "REQUEST", "description": "Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter." }, "47001": { "domain": "API", "category": "REQUEST", "description": "The category {{category_id}} specified in the request is not a valid eBay category for the marketplace." }, "47002": { "domain": "API", "category": "REQUEST", "description": "The category {{category_id}} specified in the request does not support compatibilities." }, "47003": { "domain": "API", "category": "REQUEST", "description": "A required field is missing from the request." }, "47004": { "domain": "API", "category": "REQUEST", "description": "Invalid data supplied in the request." }, "47005": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request is invalid." }, "47006": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request does not support compatibility." } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/compatibilities/get_compatibility_property_values": { "post": { "tags": [ "compatibilities" ], "description": "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.", "operationId": "getCompatibilityPropertyValues", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "This type defines the category ID and property name for which to retrieve values.", "content": { "application/json": { "schema": { "description": "This type defines the category ID and property name for which to retrieve values.", "$ref": "#/components/schemas/PropertyValuesRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyValuesResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "47000": { "domain": "API", "category": "REQUEST", "description": "Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter." }, "47002": { "domain": "API", "category": "REQUEST", "description": "The category {{category_id}} specified in the request does not support compatibilities." }, "47003": { "domain": "API", "category": "REQUEST", "description": "A required field is missing from the request." }, "47004": { "domain": "API", "category": "REQUEST", "description": "Invalid data supplied in the request." }, "47005": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request is invalid." }, "47006": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request does not support compatibility." } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/compatibilities/get_multi_compatibility_property_values": { "post": { "tags": [ "compatibilities" ], "description": "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.", "operationId": "getMultiCompatibilityPropertyValues", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "This type defines the category ID and property names for which to retrieve values.", "content": { "application/json": { "schema": { "description": "This type defines the category ID and property names for which to retrieve values.", "$ref": "#/components/schemas/MultiCompatibilityPropertyValuesRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiCompatibilityPropertyValuesResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "47000": { "domain": "API", "category": "REQUEST", "description": "Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter." }, "47002": { "domain": "API", "category": "REQUEST", "description": "The category {{category_id}} specified in the request does not support compatibilities." }, "47003": { "domain": "API", "category": "REQUEST", "description": "A required field is missing from the request." }, "47004": { "domain": "API", "category": "REQUEST", "description": "Invalid data supplied in the request." }, "47005": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request is invalid." }, "47006": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request does not support compatibility." } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/compatibilities/get_product_compatibilities": { "post": { "tags": [ "compatibilities" ], "description": "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.", "operationId": "getProductCompatibilities", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "This type defines properties for which to find compatibilities.", "content": { "application/json": { "schema": { "description": "This type defines properties for which to find compatibilities.", "$ref": "#/components/schemas/ProductRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "47000": { "domain": "API", "category": "REQUEST", "description": "Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter." }, "47003": { "domain": "API", "category": "REQUEST", "description": "A required field is missing from the request." }, "47004": { "domain": "API", "category": "REQUEST", "description": "Invalid data supplied in the request." }, "47005": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request is invalid." }, "47006": { "domain": "API", "category": "REQUEST", "description": "The marketplace id {{marketplaceId}} specified in the request does not support compatibility." } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations": { "get": { "tags": [ "shipping:marketplace" ], "description": "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.

", "operationId": "getExcludeShippingLocations", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which excluded shipping locations information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingExcludeLocationResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/shipping/marketplace/{marketplace_id}/get_handling_times": { "get": { "tags": [ "shipping:marketplace" ], "description": "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.

", "operationId": "getHandlingTimes", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which handling times information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingHandlingTimeResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/shipping/marketplace/{marketplace_id}/get_shipping_carriers": { "get": { "tags": [ "shipping:marketplace" ], "description": "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.

", "operationId": "getShippingCarriers", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which shipping carriers information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCarrierResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/shipping/marketplace/{marketplace_id}/get_shipping_locations": { "get": { "tags": [ "shipping:marketplace" ], "description": "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.

", "operationId": "getShippingLocations", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which shipping locations information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLocationResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/shipping/marketplace/{marketplace_id}/get_shipping_services": { "get": { "tags": [ "shipping:marketplace" ], "description": "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.

", "operationId": "getShippingServices", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace for which shipping services information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingServiceResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "46001": { "domain": "API_METADATA", "category": "REQUEST", "description": "The specified marketplace ID was not found." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "46000": { "domain": "API_METADATA", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/country/{countryCode}/sales_tax_jurisdiction": { "get": { "tags": [ "country" ], "description": "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! 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:

For additional information, refer to Taxes and import charges.

", "operationId": "getSalesTaxJurisdictions", "parameters": [ { "name": "countryCode", "in": "path", "description": "This path parameter specifies the two-letter ISO 3166 country code for the country whose jurisdictions you want to retrieve.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTaxJurisdictions" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "45400": { "domain": "API_METADATA", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "45401": { "domain": "API_METADATA", "category": "REQUEST", "description": "Invalid {fieldName}." }, "45402": { "domain": "API_METADATA", "category": "REQUEST", "description": "Tax table not supported for {fieldName}." } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "45500": { "domain": "API_METADATA", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } } }, "components": { "schemas": { "Amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "The three-letter eBay API documentation" }, "value": { "type": "string", "description": "The monetary amount, in the currency specified by the currency field." } }, "description": "The type that defines the fields for the currency and a monetary amount." }, "AutomotivePartsCompatibilityPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The category ID to which the automotive parts compatibility policies apply." }, "categoryTreeId": { "type": "string", "description": "A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.

A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes." }, "compatibilityBasedOn": { "type": "string", "description": "Indicates whether the category supports parts compatibility by either ASSEMBLY or by SPECIFICATION. For implementation help, refer to eBay API documentation" }, "compatibleVehicleTypes": { "type": "array", "description": "Indicates the compatibility classification of the part based on high-level vehicle types.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "maxNumberOfCompatibleVehicles": { "type": "integer", "description": "Specifies the maximum number of compatible vehicle-applications allowed per item.", "format": "int32" } } }, "AutomotivePartsCompatibilityPolicyResponse": { "type": "object", "properties": { "automotivePartsCompatibilityPolicies": { "type": "array", "description": "A list of category IDs and the automotive parts compatibility policies for each of the listed categories.", "items": { "$ref": "#/components/schemas/AutomotivePartsCompatibilityPolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "CategoryPolicy": { "type": "object", "properties": { "autoPayEnabled": { "type": "boolean", "description": "If this field is returned as true, the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the 'Buy It Now' option enabled, and for a motor vehicle listing that requires an initial deposit. If the immediate payment feature is enabled for a listing, the buyer must pay immediately after clicking the 'Buy it Now' button.

This field is only returned when true (not returned when false).

" }, "b2bVatEnabled": { "type": "boolean", "description": "If this field is returned as true, the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not have B2B VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.

This field is only returned when true (not returned when false).

" }, "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "eanSupport": { "type": "string", "description": "This enumerated value indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category. For implementation help, refer to eBay API documentation" }, "expired": { "type": "boolean", "description": "If this field is returned as true, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. You can use the getExpiredCategories method (of the Taxonomy API) to find the leaf category that replaced the expired category.

This field is only returned when true (not returned when false).

" }, "intangibleEnabled": { "type": "boolean", "description": "If this field is returned as true, the category supports the listing of intangible goods or services." }, "isbnSupport": { "type": "string", "description": "This enumerated value indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the specified category. For implementation help, refer to eBay API documentation" }, "lsd": { "type": "boolean", "description": "If this field (Lot Size Disabled) is returned as true, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction.

This field is only returned when true (not returned when false).

" }, "minimumReservePrice": { "type": "number", "description": "Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of 0.0 is returned in this field." }, "orpa": { "type": "boolean", "description": "This field (Override Reserve Price Allowed) is returned as true if the eBay marketplace's default policy is to allow reserve prices for auction listings, but the corresponding category does not allow a reserve price.

Note: This field is not returned if the marketplace does not permit reserve prices.

" }, "orra": { "type": "boolean", "description": "If this field (Override Reduce Reserve Allowed) is returned as true, the seller can reduce or remove a reserve price that had already been reduced for an active auction listing." }, "paymentMethods": { "type": "array", "description": "An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "reduceReserveAllowed": { "type": "boolean", "description": "If this field (Reduce Reserve Allowed) is true, the corresponding leaf category allows the seller to reduce an item's reserve price. If false, this field is not returned in the response and the corresponding leaf category on the site do not normally allow sellers to reduce an item's reserve price.

This field is only returned when true (not returned when false).

" }, "reservePriceAllowed": { "type": "boolean", "description": "This field indicates whether reserve prices are allowed for auction listings in this category. This field returns as true when the category supports reserve prices, or false if the eBay marketplace does not permit reserve prices or the category override blocks reserve prices (orpa is true)." }, "upcSupport": { "type": "string", "description": "This enumerated value indicates whether or not the category on the specified eBay site supports the use of Universal Product Codes (UPCs) to help create a listing. For implementation help, refer to eBay API documentation" }, "valueCategory": { "type": "boolean", "description": "When 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." }, "virtual": { "type": "boolean", "description": "If this field is returned as true, the corresponding category is an eBay virtual category, a category in which items may not be listed.

This field is only returned when true (not returned when false).

" } }, "description": "This type contains applicable policy metadata for the leaf categories returned for the marketplace." }, "CategoryPolicyResponse": { "type": "object", "properties": { "categoryPolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/CategoryPolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type contains applicable policy metadata for the leaf categories returned for the marketplace." }, "ClassifiedAdPolicy": { "type": "object", "properties": { "adFormatEnabled": { "type": "string", "description": "This enumerated value indicates the type or status of available Classified Ad formats for this category. For implementation help, refer to eBay API documentation" }, "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "classifiedAdAutoAcceptEnabled": { "type": "boolean", "description": "Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings." }, "classifiedAdAutoDeclineEnabled": { "type": "boolean", "description": "Indicates whether the category supports the Best Offer Automatic Reject feature for Classified Ad listings." }, "classifiedAdBestOfferEnabled": { "type": "string", "description": "This enumerated value indicates if Best Offer is enabled, disabled, or required for Classified Ad listings in this category. For implementation help, refer to eBay API documentation" }, "classifiedAdCompanyNameEnabled": { "type": "boolean", "description": "Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings. " }, "classifiedAdContactByAddressEnabled": { "type": "boolean", "description": "Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings. " }, "classifiedAdContactByEmailEnabled": { "type": "boolean", "description": "Indicates whether most categories support including an email address in the seller's contact information." }, "classifiedAdContactByPhoneEnabled": { "type": "boolean", "description": "Indicates whether most categories support including a phone number in the seller's contact information." }, "classifiedAdCounterOfferEnabled": { "type": "boolean", "description": "Indicates whether counter offers are allowed on Best offers for the category." }, "classifiedAdPaymentMethodEnabled": { "type": "string", "description": "This enumerated value indicates support for the payment method being displayed to the user for the category. Even if enabled, checkout may or may not be enabled. For implementation help, refer to eBay API documentation" }, "classifiedAdPhoneCount": { "type": "integer", "description": "Indicates how many contact phone numbers can be specified in contact information for the category. This element is for For Sale By Owner listings.", "format": "int32" }, "classifiedAdShippingMethodEnabled": { "type": "boolean", "description": "Indicates if shipping methods can be specified and displayed in the View Item page for the category." }, "classifiedAdStreetCount": { "type": "integer", "description": "Indicates how many street addresses can be specified in contact information for the category. This element is for For Sale By Owner listings.", "format": "int32" }, "sellerContactDetailsEnabled": { "type": "boolean", "description": "Indicates whether this category supports seller-level contact information for Classified Ad listings." } }, "description": "This type provides fields that contains applicable Classified Ad policy metadata for the leaf categories returned for the marketplace." }, "ClassifiedAdPolicyResponse": { "type": "object", "properties": { "classifiedAdPolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/ClassifiedAdPolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type contains applicable policy metadata for the leaf categories returned for the marketplace." }, "Compatibility": { "type": "object", "properties": { "compatibilityDetails": { "type": "array", "description": "This array returns a list of compatibility details associated with the specified property name(s).", "items": { "$ref": "#/components/schemas/CompatibilityDetails" } } }, "description": "This type defines the property names and values that are compatible with the property name values specified in the request." }, "CompatibilityDetails": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "The name of the property being described." }, "propertyValue": { "type": "string", "description": "The value for the property specified in the propertyName field." } }, "description": "This type defines the compatible property names and values associated with the product." }, "Currency": { "type": "object", "properties": { "code": { "type": "string", "description": "The three-letter eBay API documentation" }, "description": { "type": "string", "description": "The description of the returned three-letter code. For example, if the code is USD, the description returned would be US Dollar." } }, "description": "The type defining valid currencies for the marketplace." }, "DisabledProductFilter": { "type": "object", "properties": { "excludeForEbayReviews": { "type": "boolean", "description": "Specifies whether to filter out products excluded for eBay reviews.

If set to true, items excluded from eBay reviews are not returned." }, "excludeForEbaySelling": { "type": "boolean", "description": "Specifies whether to filter out products excluded for eBay selling.

If set to true, items excluded from eBay selling are not returned." } }, "description": "This type defines the booleans used to determine if a product is excluded from eBay selling and/or review." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:" }, "domain": { "type": "string", "description": "Name of the domain containing the service or application." }, "errorId": { "type": "integer", "description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "An expanded version of message that should be around 100-200 characters long, but is not required to be such." }, "message": { "type": "string", "description": "An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale." }, "outputRefIds": { "type": "array", "description": "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain." } }, "description": "A container that defines the elements of error and warning messages." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the entity that threw the error." }, "value": { "type": "string", "description": "A description of the error." } }, "description": "Container for an error parameter." }, "ExtendedProducerResponsibility": { "type": "object", "properties": { "enabledForVariations": { "type": "boolean", "description": "An indication of whether the attribute can be enabled for listing variations.

If the value is true, the attribute may be specified at the variation level." }, "name": { "type": "string", "description": "The name of the attribute included in the policy. For implementation help, refer to eBay API documentation" }, "usage": { "type": "string", "description": "The usage guidelines for the attribute, in the specified marketplace. For implementation help, refer to eBay API documentation" } }, "description": "A type that defines the attributes of an Extended Producer Responsibility policy." }, "ExtendedProducerResponsibilityPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier for the category under which the policy applies." }, "categoryTreeId": { "type": "string", "description": "The unique identifier for the category tree under which the policy applies." }, "supportedAttributes": { "type": "array", "description": "The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level.", "items": { "$ref": "#/components/schemas/ExtendedProducerResponsibility" } } }, "description": "A type that defines the Extended Producer Responsibility policy." }, "ExtendedProducerResponsibilityPolicyResponse": { "type": "object", "properties": { "extendedProducerResponsibilities": { "type": "array", "description": "An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace.", "items": { "$ref": "#/components/schemas/ExtendedProducerResponsibilityPolicy" } }, "warnings": { "type": "array", "description": "A collection of warnings generated for the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A type that defines the response fields for the getExtendedProducerResponsibilityPolicies method." }, "GetCurrenciesResponse": { "type": "object", "properties": { "defaultCurrency": { "description": "This field specifies the default currency used by the marketplace.", "$ref": "#/components/schemas/Currency" }, "marketplaceId": { "type": "string", "description": "The ID of the eBay marketplace to which the default currency applies. For implementation help, refer to eBay API documentation" } }, "description": "This type defines the response fields specifying the default currency for the marketplace." }, "HazardStatement": { "type": "object", "properties": { "statementId": { "type": "string", "description": "The identifier of the statement. For sample values, see Hazard statement sample values." }, "statementDescription": { "type": "string", "description": "The description of the statement localized to the default language of the marketplace. For sample values, see Hazard statement sample values." } }, "description": "A type that describes hazard statements for hazardous materials labels" }, "HazardousMaterialDetailsResponse": { "type": "object", "properties": { "signalWords": { "type": "array", "description": "This array contains available hazardous materials signal words for the specified marketplace.", "items": { "$ref": "#/components/schemas/SignalWord" } }, "statements": { "type": "array", "description": "This array contains available hazardous materials hazard statements for the specified marketplace.", "items": { "$ref": "#/components/schemas/HazardStatement" } }, "pictograms": { "type": "array", "description": "This array contains available hazardous materials hazard pictograms for the specified marketplace.", "items": { "$ref": "#/components/schemas/Pictogram" } } }, "description": "A type that defines the response fields for the getHazardousMaterialsLabels method." }, "ItemCondition": { "type": "object", "properties": { "conditionDescription": { "type": "string", "description": "The human-readable label for the condition (e.g., \"New\"). This value is typically localized for each site.

Note that the display name can vary by category. For example, the description for condition ID 1000 could be called \"New: with Tags\" in one category and \"Brand New\" in another. For details on condition IDs and descriptions, see Item condition ID and name values." }, "conditionDescriptors": { "type": "array", "description": "This array contains the possible condition descriptors and condition descriptor values applicable for the specified category. It also returns usage requirements, maximum length, cardinality, and help text.

Note: This array is only returned for categories that support condition descriptors.", "items": { "$ref": "#/components/schemas/ItemConditionDescriptor" } }, "conditionHelpText": { "type": "string", "description": "A detailed description of the condition denoted by the conditionID and conditionDescription. " }, "conditionId": { "type": "string", "description": "The ID value of the selected item condition. For information on the supported condition ID values, see Item condition ID and name values." }, "usage": { "type": "string", "description": "The value returned in this field indicates if there are any usage restrictions or requirements for the corresponding item condition in the corresponding category.

Note: Currently, the only supported value is 'RESTRICTED', and this field will only be returned for the following conditions: 2000, 2010, 2020, 2030. Sellers must be pre-approved to use any of these item conditions. For implementation help, refer to eBay API documentation" } }, "description": "Note: In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. Any active listings on any eBay marketplace that had 'Manufacturer Refurbished' as the item condition should have been automatically updated by eBay to the 'Seller Refurbished' item condition (Condition ID 2500).

Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center. " }, "ItemConditionDescriptor": { "type": "object", "properties": { "conditionDescriptorConstraint": { "description": "This container shows the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs.", "$ref": "#/components/schemas/ItemConditionDescriptorConstraint" }, "conditionDescriptorHelpText": { "type": "string", "description": "A description of the condition descriptor that directs a user to its condition descriptor values.

For example, the help text for Card Condition is Select ungraded condition." }, "conditionDescriptorId": { "type": "string", "description": "The unique identification number of a condition descriptor associated with with a conditionDescriptorName.

For example, 40001 is the ID for Card Condition.

These IDs are used in the addItem family of calls of the Trading API to provide condition descriptor names for the item. These IDs are used by the inventoryItem family of calls of the Inventory API to provide condition descriptor names for the item." }, "conditionDescriptorName": { "type": "string", "description": "The human-readable label for the condition descriptor associated with the conditionDescriptorID.

For example, Card Condition is the condition descriptor name for ID 40001" }, "conditionDescriptorValues": { "type": "array", "description": "This array shows the possible values that map to the corresponding conditionDescriptorName values. Constraint information and help text are also shown for each value.

For example, The ID 40001 is ID for the condition descriptor card condition. The ID 400012 is the ID for the Very Good card condition value.", "items": { "$ref": "#/components/schemas/ItemConditionDescriptorValue" } } }, "description": "This type is used to display the possible condition descriptors and condition values applicable for a specified category. It also returns usage requirements, maximum length, cardinality, and help text." }, "ItemConditionDescriptorConstraint": { "type": "object", "properties": { "applicableToConditionDescriptorIds": { "type": "array", "description": "This array is returned if the corresponding condition descriptor requires that one or more other associated condition descriptors must also be specified in a listing. The condition descriptor IDs for the associated condition descriptors are returned here.

For example, the Grade and Grader condition descriptors must always be specified together in a listing for Graded cards.", "items": { "type": "string" } }, "cardinality": { "type": "string", "description": "The value returned in this field indicates whether a condition descriptor can have a single value or multiple values. For implementation help, refer to eBay API documentation" }, "defaultConditionDescriptorValueId": { "type": "string", "description": "The default condition descriptor value that will be set if there are multiple values." }, "maxLength": { "type": "integer", "description": "The maximum characters allowed for a condition descriptor. This field is only returned/applicable for condition descriptors that allow free text for condition descriptor values. ", "format": "int32" }, "mode": { "type": "string", "description": "The value returned in this field indicates whether the supported values for a condition descriptor are predefined or if the seller manually specified the value.

Note: FREE_TEXT is currently only applicable to the Certification Number condition descriptor. For implementation help, refer to eBay API documentation" }, "usage": { "type": "string", "description": "This value indicates whether or not the condition descriptor is required for the item condition. Currently, this field is only returned if the condition descriptor is required for the item condition. For implementation help, refer to eBay API documentation" } }, "description": "This type specifies the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs." }, "ItemConditionDescriptorValue": { "type": "object", "properties": { "conditionDescriptorValueAdditionalHelpText": { "type": "array", "description": "Additional information about the the condition of the item that is not included in the conditionDescriptorValueHelpText field.", "items": { "type": "string" } }, "conditionDescriptorValueConstraints": { "type": "array", "description": "The constraints on a condition descriptor value, such as which descriptor value IDs and Descriptor ID it is associated with.", "items": { "$ref": "#/components/schemas/ItemConditionDescriptorValueConstraint" } }, "conditionDescriptorValueHelpText": { "type": "string", "description": "A detailed description of the condition descriptor value. " }, "conditionDescriptorValueId": { "type": "string", "description": "The unique identification number of a condition descriptor value associated with the conditionDescriptorValueName." }, "conditionDescriptorValueName": { "type": "string", "description": "The human-readable label for the condition descriptor value associated with the conditionDescriptorValueID." } }, "description": "This type displays the possible values for the corresponding condition descriptor, along with help text and constraint information." }, "ItemConditionDescriptorValueConstraint": { "type": "object", "properties": { "applicableToConditionDescriptorId": { "type": "string", "description": "This string is returned if the corresponding condition descriptor value requires an associated condition descriptor that must also be specified in a listing. The condition descriptor ID for the associated condition descriptors is returned here." }, "applicableToConditionDescriptorValueIds": { "type": "array", "description": "This array is returned if the corresponding condition descriptor value is required for one or more associated condition descriptor values that must also be specified in a listing. The condition descriptor values IDs for the associated condition descriptor values are returned here.", "items": { "type": "string" } } }, "description": "This type shows the constraints on a condition descriptor value, such as any associated condition descriptor ID and condition descriptor value IDs required for a listing." }, "ItemConditionPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The category ID to which the item-condition policy applies." }, "categoryTreeId": { "type": "string", "description": "A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.

A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes." }, "itemConditionRequired": { "type": "boolean", "description": "This flag denotes whether or not you must list the item condition in a listing for the specified category. If set to true, you must specify an item condition for the associated category." }, "itemConditions": { "type": "array", "description": "The item-condition values allowed in the category.

Note: The ‘Seller Refurbished’ item condition (condition ID 2500) has been replaced by the 'Excellent - Refurbished', 'Very Good - Refurbished', and 'Good - Refurbished' item conditions in a select number of eBay marketplaces and categories.

Similar to the ‘Certified Refurbished’ item condition (condition ID 2000), a seller’s OAuth user token will have to be used instead of an OAuth application token, since each seller must go through an application and qualification process before using any of these new refurbished item conditions in supported categories. If a seller is not qualified to use the new refurbished item conditions, these item condition values will not be returned by getItemConditionPolicies.", "items": { "$ref": "#/components/schemas/ItemCondition" } } } }, "ItemConditionPolicyResponse": { "type": "object", "properties": { "itemConditionPolicies": { "type": "array", "description": "A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories.", "items": { "$ref": "#/components/schemas/ItemConditionPolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "ListingDuration": { "type": "object", "properties": { "durationValues": { "type": "array", "description": "This array defines the supported time duration options available for the listing type.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "listingType": { "type": "string", "description": "The enumerated value returned in this field indicates the listing type for the duration value(s). For implementation help, refer to eBay API documentation" } }, "description": "This type identifies the kind of listing and its duration periods." }, "ListingStructurePolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The category ID to which the listing-structure policy applies." }, "categoryTreeId": { "type": "string", "description": "A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.

A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes." }, "variationsSupported": { "type": "boolean", "description": "This flag denotes whether or not the associated category supports listings with item variations. If set to true, the category does support item variations." } } }, "ListingStructurePolicyResponse": { "type": "object", "properties": { "listingStructurePolicies": { "type": "array", "description": "Returns a list of category IDs plus a flag indicating whether or not each listed category supports item variations.", "items": { "$ref": "#/components/schemas/ListingStructurePolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "ListingTypePoliciesResponse": { "type": "object", "properties": { "listingTypePolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/ListingTypePolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type contains the selling formats for eBay listings." }, "ListingTypePolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "digitalGoodDeliveryEnabled": { "type": "boolean", "description": "A true value in this field indicates that the leaf category supports the listing of items (such as gift cards) that can be delivered electronically via a download link or sent to a buyer's email address." }, "listingDurations": { "type": "array", "description": "An array of eBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type.", "items": { "$ref": "#/components/schemas/ListingDuration" } }, "pickupDropOffEnabled": { "type": "boolean", "description": "A true value in this field indicates that items listed in the category (specified in the listingTypePolicies.categoryId field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available. A false value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature." } }, "description": "This type contains the policies governing the listing type by category." }, "LocalListingDistance": { "type": "object", "properties": { "distances": { "type": "array", "description": "This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings.", "items": { "type": "integer" } }, "distanceType": { "type": "string", "description": "This enumerated value indicates the type of local listing distances, such as non-subscription or regular, for items listed by sellers. For implementation help, refer to eBay API documentation" } }, "description": "This type contains the kind of distance and radius of the selling area for Local Market Vehicle listings." }, "MotorsListingPoliciesResponse": { "type": "object", "properties": { "motorsListingPolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/MotorsListingPolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "MotorsListingPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "depositSupported": { "type": "boolean", "description": "This field is returned as true if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an AddItem call, the seller can configure a down payment for a motor vehicle listing using the PaymentDetails container." }, "ebayMotorsProAdFormatEnabled": { "type": "string", "description": "Indicates whether or not eBay Motors Pro sellers can use classified ads in this category to sell their vehicles. This element is applicable for eBay Motors Pro users. For implementation help, refer to eBay API documentation" }, "ebayMotorsProAutoAcceptEnabled": { "type": "boolean", "description": "Indicates whether or not the category supports the Best Offer Auto Accept feature for eBay Motors Pro listings. This element is for eBay Motors Pro users." }, "ebayMotorsProAutoDeclineEnabled": { "type": "boolean", "description": "Indicates whether or not the category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users." }, "ebayMotorsProBestOfferEnabled": { "type": "string", "description": "This enumerated value indicates whether or not Best Offer features are supported for eBay Motors Classified Ad listings in this category. This element is for eBay Motors Pro users. For implementation help, refer to eBay API documentation" }, "ebayMotorsProCompanyNameEnabled": { "type": "boolean", "description": "Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users." }, "ebayMotorsProContactByAddressEnabled": { "type": "boolean", "description": "Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users." }, "ebayMotorsProContactByEmailEnabled": { "type": "boolean", "description": "Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users." }, "ebayMotorsProContactByPhoneEnabled": { "type": "boolean", "description": "Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users." }, "ebayMotorsProCounterOfferEnabled": { "type": "boolean", "description": "Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users." }, "ebayMotorsProPaymentMethodCheckOutEnabled": { "type": "string", "description": "This enumerated value indicates whether this category supports that the payment method should be displayed to the user for this category in an eBay Motors Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users. For implementation help, refer to eBay API documentation" }, "ebayMotorsProPhoneCount": { "type": "integer", "description": "Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users.", "format": "int32" }, "ebayMotorsProSellerContactDetailsEnabled": { "type": "boolean", "description": "Indicates whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users." }, "ebayMotorsProShippingMethodEnabled": { "type": "boolean", "description": "Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users." }, "ebayMotorsProStreetCount": { "type": "integer", "description": "This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users.", "format": "int32" }, "epidSupported": { "type": "boolean", "description": "If returned as true, this indicates the category supports the use of an eBay Product ID (e.g. ePID) to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites." }, "kTypeSupported": { "type": "boolean", "description": "This field indicates whether or not 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. See Compatibility by K type for more information" }, "localListingDistances": { "type": "array", "description": "This array shows the supported distances (in miles) for different types of Local Market subscription types in this category. Motor vehicle listings will be shown to buyers located within these proximities of the vehicle's location.", "items": { "$ref": "#/components/schemas/LocalListingDistance" } }, "localMarketAdFormatEnabled": { "type": "string", "description": "Specifies whether this category supports Motor Local Market Classified Ad listings. For implementation help, refer to eBay API documentation" }, "localMarketAutoAcceptEnabled": { "type": "boolean", "description": "Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads." }, "localMarketAutoDeclineEnabled": { "type": "boolean", "description": "Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads." }, "localMarketBestOfferEnabled": { "type": "string", "description": "Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category. For implementation help, refer to eBay API documentation" }, "localMarketCompanyNameEnabled": { "type": "boolean", "description": "Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads." }, "localMarketContactByAddressEnabled": { "type": "boolean", "description": "Indicates whether this category supports including the address in the seller's contact information." }, "localMarketContactByEmailEnabled": { "type": "boolean", "description": "Indicates whether the category supports including an email address in the seller's contact information. " }, "localMarketContactByPhoneEnabled": { "type": "boolean", "description": "Indicates whether this category supports including the telephone in the seller's contact information." }, "localMarketCounterOfferEnabled": { "type": "boolean", "description": "Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings." }, "localMarketNonSubscription": { "type": "boolean", "description": "Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers." }, "localMarketPaymentMethodCheckOutEnabled": { "type": "string", "description": "Indicates if the payment method should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled. For implementation help, refer to eBay API documentation" }, "localMarketPhoneCount": { "type": "integer", "description": "Indicates the number of phone numbers that can be included through contact information for this category.", "format": "int32" }, "localMarketPremiumSubscription": { "type": "boolean", "description": "Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers." }, "localMarketRegularSubscription": { "type": "boolean", "description": "Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers." }, "localMarketSellerContactDetailsEnabled": { "type": "boolean", "description": "Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings." }, "localMarketShippingMethodEnabled": { "type": "boolean", "description": "Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled." }, "localMarketSpecialitySubscription": { "type": "boolean", "description": "Indicates whether the category supports the Speciality level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers." }, "localMarketStreetCount": { "type": "integer", "description": "Indicates which address option is enabled for the seller's contact information.", "format": "int32" }, "maxGranularFitmentCount": { "type": "integer", "description": "Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine.", "format": "int32" }, "maxItemCompatibility": { "type": "integer", "description": "Indicates the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually only. See Specify parts compatibility manually and Managing product compatibility for more information.", "format": "int32" }, "minItemCompatibility": { "type": "integer", "description": "Indicates the minimum number of required compatible applications for listing items. A value of 0 indicates it is not mandatory to specify parts compatibilities when listing.", "format": "int32" }, "nonSubscription": { "type": "string", "description": "The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription. For implementation help, refer to eBay API documentation" }, "premiumSubscription": { "type": "string", "description": "The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription. For implementation help, refer to eBay API documentation" }, "regularSubscription": { "type": "string", "description": "The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription. For implementation help, refer to eBay API documentation" }, "sellerProvidedTitleSupported": { "type": "boolean", "description": "This field is returned as true if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle. Visually, the seller-provided title is similar to a subtitle on other types of eBay listings (non-vehicle). A seller-provided title can assist in helping buyers discover the vehicle." }, "specialitySubscription": { "type": "string", "description": "The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription. For implementation help, refer to eBay API documentation" }, "vinSupported": { "type": "boolean", "description": "Indicates if Vehicle Identification Number is supported." }, "vrmSupported": { "type": "boolean", "description": "Indicates if Vehicle Registration Mark is supported." } } }, "MultiCompatibilityPropertyValuesRequest": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which to retrieve property values.

Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility." }, "propertyFilters": { "type": "array", "description": "This array can be used to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response.

For example, if the propertyName is set to Year and the propertyValue is set to 2022, only compatible vehicles from 2022 will be returned.

At least one property name-value pair must be used.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } }, "propertyNames": { "type": "array", "description": "This comma-delimited array specifies the names of the properties for which to retrieve associated property values.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.", "items": { "type": "string" } } }, "description": "This type defines the request fields used in the getMultiCompatibilityPropertyValues method." }, "MultiCompatibilityPropertyValuesResponse": { "type": "object", "properties": { "compatibilities": { "type": "array", "description": "This container defines the compatibility details associated with the specified property name value(s).", "items": { "$ref": "#/components/schemas/Compatibility" } }, "metadataVersion": { "type": "string", "description": "The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace." } }, "description": "This type defines the response fields for the getMultiCompatibilityPropertyValues method." }, "NegotiatedPricePolicy": { "type": "object", "properties": { "bestOfferAutoAcceptEnabled": { "type": "boolean", "description": "This flag denotes whether or not the category supports the setting of a price at which best offers are automatically accepted. If set to true, the category does support the setting of an automatic price for best-offers." }, "bestOfferAutoDeclineEnabled": { "type": "boolean", "description": "This flag denotes whether or not the category supports the setting of an auto-decline price for best offers. If set to true, the category does support the setting of an automatic-decline price for best-offers." }, "bestOfferCounterEnabled": { "type": "boolean", "description": "This flag denotes whether or not the category supports the setting for an automatic counter-offer on best offers. If set to true, the category does support the setting of an automatic counter-offer price for best-offers." }, "categoryId": { "type": "string", "description": "The category ID to which the negotiated-price policies apply." }, "categoryTreeId": { "type": "string", "description": "A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.

A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes." } } }, "NegotiatedPricePolicyResponse": { "type": "object", "properties": { "negotiatedPricePolicies": { "type": "array", "description": "A list of category IDs and the policies related to negotiated-price items for each of the listed categories.", "items": { "$ref": "#/components/schemas/NegotiatedPricePolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "PackageLimits": { "type": "object", "properties": { "dimensionUnit": { "type": "string", "description": "Unit of dimensional measurement, for example INCH or CENTIMETER. " }, "maxGirth": { "type": "number", "description": "The maximum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "maxHeight": { "type": "number", "description": "The maximum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "maxLength": { "type": "number", "description": "The maximum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "maxWeight": { "type": "number", "description": "The maximum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit." }, "maxWidth": { "type": "number", "description": "The maximum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "minGirth": { "type": "number", "description": "The minimum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "minHeight": { "type": "number", "description": "The minimum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "minLength": { "type": "number", "description": "The minimum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "minWeight": { "type": "number", "description": "The minimum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit." }, "minWidth": { "type": "number", "description": "The minimum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit." }, "weightUnit": { "type": "string", "description": "Unit of weight measurement, for example KILOGRAM or OUNCE. " } }, "description": "The packageLimits field is used to specify the physical constraints and measurement units of packages, ensuring compliance with various shipping requirements." }, "Pagination": { "type": "object", "properties": { "count": { "type": "integer", "description": "The number of results showing on the current page of results.", "format": "int32" }, "limit": { "type": "integer", "description": "The max number of entries that can be returned on a single page.", "format": "int32" }, "offset": { "type": "integer", "description": "The number of items that will be skipped in the result set before returning the first item in the paginated response.", "format": "int32" }, "total": { "type": "integer", "description": "The total number of results in a result set.", "format": "int32" } }, "description": "This type defines the pagination settings for a result set." }, "PaginationInput": { "type": "object", "properties": { "limit": { "type": "integer", "description": "The max number of items, from the current result set, returned on a single page.

Note: For getProductCompatibilities, the max value is 100. If no limit is specified, this field defaults to the max value.", "format": "int32" }, "offset": { "type": "integer", "description": "The number of items that will be skipped in the result set before returning the first item in the paginated response.

Combine offset with limit to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0", "format": "int32" } }, "description": "This type defines the fields used to control the pagination of the result set." }, "Pictogram": { "type": "object", "properties": { "pictogramId": { "type": "string", "description": "The identifier of the pictogram. For sample values, see Pictogram sample values." }, "pictogramDescription": { "type": "string", "description": "The description of the pictogram localized to the default language of the marketplace. For sample values, see Pictogram sample values." }, "pictogramUrl": { "type": "string", "description": "The URL of the pictogram." } }, "description": "A type that describes pictograms for hazardous materials labels." }, "ProductIdentifier": { "type": "object", "properties": { "ean": { "type": "string", "description": "The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America." }, "epid": { "type": "string", "description": "The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog.

Use the getProduct method of the Catalog API to retrieve the ePID of an item." }, "isbn": { "type": "string", "description": "The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books." }, "productId": { "type": "string", "description": "The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product." }, "upc": { "type": "string", "description": "The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America." } }, "description": "This type defines the supported product identifiers." }, "ProductRequest": { "type": "object", "properties": { "applicationPropertyFilters": { "type": "array", "description": "This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response.

Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } }, "dataset": { "type": "array", "description": "This array defines the type of properties that are returned for the catalog-enabled category.

For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.

Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:
Default: DisplayableSearchResults", "items": { "type": "string" } }, "datasetPropertyName": { "type": "array", "description": "This comma-delimted array can be used to define the specific property name(s) that will be returned in the response.

For example, if you specify Engine, the result set will only contain engines that are compatible with the input criteria.

Note: This array cannot be used alongside dataset. If both are used, an error will occur.", "items": { "type": "string" } }, "disabledProductFilter": { "description": "This container can be used to specify whether or not to filter out products which are disabled for selling on eBay and/or disabled for product review. ", "$ref": "#/components/schemas/DisabledProductFilter" }, "paginationInput": { "description": "This container controls the pagination of the result set.", "$ref": "#/components/schemas/PaginationInput" }, "productIdentifier": { "description": "This container is used to provide unique identifier for the product. The product identifier consists of an identifier type and value, and are unique across all sites.", "$ref": "#/components/schemas/ProductIdentifier" }, "sortOrders": { "type": "array", "description": "This array controls the sort order of compatibility properties.", "items": { "$ref": "#/components/schemas/SortOrderInner" } } }, "description": "This type defines the request fields for the getProductCompatibilities method." }, "ProductResponse": { "type": "object", "properties": { "compatibilityDetails": { "type": "array", "description": "This container provides compatibility details for the specified product.", "items": { "$ref": "#/components/schemas/ProductResponseCompatibilityDetails" } }, "pagination": { "description": "This container returns the pagination settings for the result set.", "$ref": "#/components/schemas/Pagination" } }, "description": "This type defines the response fields for the getProductCompatibilities method." }, "ProductResponseCompatibilityDetails": { "type": "object", "properties": { "noteDetails": { "type": "array", "description": "This array returns additional comments about the corresponding product in the form of name-value pairs.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } }, "productDetails": { "type": "array", "description": "This array returns details about the product in the form of name-value pairs. ", "items": { "$ref": "#/components/schemas/PropertyValues" } } }, "description": "This type defines the compatibility details for a product." }, "ProductSafetyLabelPictogram": { "type": "object", "properties": { "pictogramDescription": { "type": "string", "description": "The description of the pictogram localized to the default language of the marketplace. " }, "pictogramId": { "type": "string", "description": "The identifier of the pictogram." }, "pictogramUrl": { "type": "string", "description": "The URL of the pictogram." } }, "description": "A type that describes pictograms for product safety labels." }, "ProductSafetyLabelStatement": { "type": "object", "properties": { "statementDescription": { "type": "string", "description": "The description of the statement localized to the default language of the marketplace. " }, "statementId": { "type": "string", "description": "The identifier of the statement." } }, "description": "A type that describes statements for product safety labels." }, "ProductSafetyLabelsResponse": { "type": "object", "properties": { "pictograms": { "type": "array", "description": "This array contains a list of pictograms of product safety labels for the specified marketplace.", "items": { "$ref": "#/components/schemas/ProductSafetyLabelPictogram" } }, "statements": { "type": "array", "description": "This array contains available product safety labels statements for the specified marketplace. ", "items": { "$ref": "#/components/schemas/ProductSafetyLabelStatement" } } }, "description": "A type that defines the response fields for the getProductSafetyLabels method." }, "PropertyFilterInner": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "The name of the property being described.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category." }, "propertyValue": { "type": "string", "description": "The value for the property specified in the properyName field.

For example, if the propertyName is Make, then the propertyValue will be the specific make of the vehicle, such as Toyota. Use the getCompatibilityPropertyValues to retreive valid property values associated with a specified property name." }, "unitOfMeasurement": { "type": "string", "description": "The unit of measurement of the property being described, if applicable." }, "url": { "type": "string", "description": "The URL associated with the property being described, if applicable." } }, "description": "This type is used to define the available compatibility property filters." }, "PropertyNamesRequest": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which to retrieve compatibility property names. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility.

Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility." }, "dataset": { "type": "array", "description": "This array defines the properties that will be returned for the compatibility-enabled category.

For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.

Valid values:Default: DisplayableSearchResults", "items": { "type": "string" } } }, "description": "This type defines the request fields for the getCompatibilityPropertyNames method." }, "PropertyNamesResponse": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay category specified in the request." }, "properties": { "type": "array", "description": "This array contains all of the properties for the specified category.", "items": { "$ref": "#/components/schemas/PropertyNamesResponseProperties" } } }, "description": "This type defines the fields returned in the getCompatibilityPropertyNames method." }, "PropertyNamesResponseProperties": { "type": "object", "properties": { "dataset": { "type": "string", "description": "This field defines the types of properties are returned for the specified catalog-enabled category.

Valid values:" }, "propertyNames": { "type": "array", "description": "This array specifies the names of the properties associated with the specified category in the specified marketplace.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.", "items": { "$ref": "#/components/schemas/PropertyNamesResponsePropertyNames" } } }, "description": "This type defines the properties and dataset for a specified category." }, "PropertyNamesResponsePropertyNameMetadata": { "type": "object", "properties": { "displaySequence": { "type": "integer", "description": "The numeric value indicating the ordering position of the property.", "format": "int32" } }, "description": "This type defines the property name metadata." }, "PropertyNamesResponsePropertyNames": { "type": "object", "properties": { "propertyDisplayName": { "type": "string", "description": "The display name of a property. This is the localized name of the compatible property." }, "propertyName": { "type": "string", "description": "The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility." }, "propertyNameMetadata": { "description": "The metadata for a property.", "$ref": "#/components/schemas/PropertyNamesResponsePropertyNameMetadata" } }, "description": "This type defines the fields associated with a property name." }, "PropertyValues": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "The name of the property.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category." }, "propertyValue": { "type": "string", "description": "The value for the property specified in the properyName field.

For example, if the propertyName is make, then the propertyValue will be the specific make of the vehicle, such as Toyota." } }, "description": "This type defines the name-value pair associated with a property value." }, "PropertyValuesRequest": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility.

Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility." }, "propertyFilters": { "type": "array", "description": "This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response.

For example, if the propertyName is set to Make and the propertyValue is set to Honda, only compatible Honda vehicles will be returned.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } }, "propertyName": { "type": "string", "description": "This field specifies the name of the property for which to retrieve associated property values.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category." }, "sortOrder": { "type": "string", "description": "This field specifies the sort order for the property values in the result set.

Valid values:Note: If no search order is specified, values are sorted in ascending order." } }, "description": "This type defines the request fields used in the getCompatibilityPropertyValues method." }, "PropertyValuesResponse": { "type": "object", "properties": { "metadataVersion": { "type": "string", "description": "The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace." }, "propertyName": { "type": "string", "description": "The name of the property specified in the request." }, "propertyValues": { "type": "array", "description": "This array specifies the property values associated with the specified propertyName, in the specified category.", "items": { "type": "string" } } }, "description": "This type defines the response fields used in the getCompatibilityPropertyValues method." }, "RegulatoryAttribute": { "type": "object", "properties": { "name": { "type": "string", "description": "A unique value identifying a specific regulatory attribute. For implementation help, refer to eBay API documentation" }, "usage": { "type": "string", "description": "The enumeration value in this field indicates whether the corresponding attribute is recommended or required for the corresponding leaf category. For implementation help, refer to eBay API documentation" } }, "description": "A type that defines the attributes of a regulatory policy." }, "RegulatoryPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the leaf category to which the corresponding policies pertain." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree, which reflects the specified marketplace." }, "supportedAttributes": { "type": "array", "description": "A list of supported regulatory attributes for this marketplace.", "items": { "$ref": "#/components/schemas/RegulatoryAttribute" } } }, "description": "A type that defines the regulatory policy." }, "RegulatoryPolicyResponse": { "type": "object", "properties": { "regulatoryPolicies": { "type": "array", "description": "A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace.", "items": { "$ref": "#/components/schemas/RegulatoryPolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A type that defines the response fields for the getRegulatoryPolicies method." }, "ReturnPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The category ID to which the return policies apply." }, "categoryTreeId": { "type": "string", "description": "A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.

A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes." }, "domestic": { "description": "This complex type defines the category policies related to domestic item returns.", "$ref": "#/components/schemas/ReturnPolicyDetails" }, "international": { "description": "This complex type defines the category policies related to international item returns.", "$ref": "#/components/schemas/ReturnPolicyDetails" }, "required": { "type": "boolean", "description": "If set to true, this flag indicates that you must specify a return policy for items listed in the associated category.

Note that not accepting returns (setting returnsAcceptedEnabled to false) is a valid return policy." } } }, "ReturnPolicyDetails": { "type": "object", "properties": { "policyDescriptionEnabled": { "type": "boolean", "description": "If set to true, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Account API's createReturnPolicy). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces.

Note: Depending on the API used to setup your return policy, return instructions are defined differently." }, "refundMethods": { "type": "array", "description": "A list of refund methods allowed for the associated category.

Note: Depending on the API used to setup your return policy, available refund methods are defined differently.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "returnMethods": { "type": "array", "description": "A list of return methods allowed for the associated category.

Note: Depending on the API used to setup your return policy, available return methods are defined differently.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "returnPeriods": { "type": "array", "description": "A list of return periods allowed for the associated category.

Note: Depending on the API used to setup your return policy, return periods are defined differently.", "items": { "$ref": "#/components/schemas/TimeDuration" } }, "returnsAcceptanceEnabled": { "type": "boolean", "description": "A value of true in this field indicates that return policies are applicable to the corresponding leaf category.

Note: Depending on the API used to setup your return policy, whether or not you accept returns is configured as follows:" }, "returnShippingCostPayers": { "type": "array", "description": "A list of allowed values for who pays for the return shipping cost.

Note that for SNAD returns, the seller is always responsible for the return shipping cost.

Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } } }, "description": "This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively)." }, "ReturnPolicyResponse": { "type": "object", "properties": { "returnPolicies": { "type": "array", "description": "A list of elements, where each contains a category ID and a flag that indicates whether or not listings in that category require a return policy.", "items": { "$ref": "#/components/schemas/ReturnPolicy" } }, "warnings": { "type": "array", "description": "A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } } }, "SalesTaxJurisdiction": { "type": "object", "properties": { "salesTaxJurisdictionId": { "type": "string", "description": "The unique ID for a sales-tax jurisdiction.

Important! When countryCode is set to US, IDs for all 50 states, Washington, DC, and all US territories will be returned. However, the only salesTaxJurisdictionId values currently supported are:

" } }, "description": "A unique ID for a sales tax jurisdiction." }, "SalesTaxJurisdictions": { "type": "object", "properties": { "salesTaxJurisdictions": { "type": "array", "description": "A list of sales-tax jurisdictions.", "items": { "$ref": "#/components/schemas/SalesTaxJurisdiction" } } }, "description": "This complex type contains a list of sales-tax jurisdictions." }, "ShippingCarrier": { "type": "object", "properties": { "description": { "type": "string", "description": "The localized description of the shipping carrier, such as UPS, FedEx, and USPS." }, "shippingCarrier": { "type": "string", "description": "An enumerated value describing the shipping carrier returned, for example, UPS, FedEx, and USPS. These values are needed when providing shipment tracking information for each specific shipping carrier." } }, "description": "This type provides applicable shipping carrier metadata for the marketplace." }, "ShippingCarrierResponse": { "type": "object", "properties": { "shippingCarriers": { "type": "array", "description": "A list of shipping carriers available for the marketplace.", "items": { "$ref": "#/components/schemas/ShippingCarrier" } } }, "description": "This type provides applicable shipping carrier metadata for returned for the marketplace." }, "ShippingExcludeLocation": { "type": "object", "properties": { "description": { "type": "string", "description": "The localized location name." }, "location": { "type": "string", "description": " The location or region to be excluded. Countries are returned through ISO 3166 codes. This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii). The values returned in this field are used in fulfillment business policies (such as in regionName) or through the ExcludeShipToLocation field in an AddItem call." }, "region": { "type": "string", "description": "The region of the excluded shipping area specified, such as:
" } }, "description": "This type provides applicable locations or region codes to be excluded set by the seller." }, "ShippingExcludeLocationResponse": { "type": "object", "properties": { "excludeShippingLocations": { "type": "array", "description": "The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that the seller has designated as excluded shipping locations.", "items": { "$ref": "#/components/schemas/ShippingExcludeLocation" } } }, "description": "This type provides applicable locations or region codes to be excluded." }, "ShippingHandlingTime": { "type": "object", "properties": { "description": { "type": "string", "description": "The localized description of the maximum handling time." }, "extendedHandling": { "type": "boolean", "description": "This field is only returned if its value is true. If returned, it indicates that the corresponding handling time is considered extended handling for the marketplace. Extended handling times may be used for freight shipping, but should generally be avoided if possible, as they might adversely affect the buying decisions of potential customers." }, "maxHandlingTime": { "type": "integer", "description": "The integer value returned in this field indicates the maximum number of business days that the eBay site allows as a seller's handling time measured from when the buyer pays for the order. For example, if the maxHandlingTime value is set to 1 and a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday).

A maxHandlingTime value of 0 indicates same day handling for an item. In this case, the seller's handling time commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).", "format": "int32" } }, "description": "This type provides applicable shipping handling time metadata." }, "ShippingHandlingTimeResponse": { "type": "object", "properties": { "handlingTimes": { "type": "array", "description": "A list of supported handling times for the marketplace.", "items": { "$ref": "#/components/schemas/ShippingHandlingTime" } } }, "description": "This type provides applicable shipping handling times returned for the specified marketplace." }, "ShippingLocation": { "type": "object", "properties": { "description": { "type": "string", "description": "The localized location name." }, "shippingLocation": { "type": "string", "description": "The name or abbreviation of the shipping location or region. Countries are returned through ISO 3166 codes. This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii). The values returned in this field are used in fulfillment business policies (such as in regionName) or through the ExcludeShipToLocation field in an AddItem call." } }, "description": "This type provides applicable shipping location metadata." }, "ShippingLocationResponse": { "type": "object", "properties": { "shippingLocations": { "type": "array", "description": "The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that can be set as shipping locations.", "items": { "$ref": "#/components/schemas/ShippingLocation" } } }, "description": "This type provides applicable shipping location metadata returned." }, "ShippingPoliciesResponse": { "type": "object", "properties": { "shippingPolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/ShippingPolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type provides fields applicable for shipping policy metadata for the leaf categories returned for the marketplace." }, "ShippingPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "globalShippingEnabled": { "type": "boolean", "description": "Indicates if the Global Shipping Program (GSP) is supported for the category.

Note: GSP is only supported by the eBay UK marketplace (EBAY_GB).

" }, "group1MaxFlatShippingCost": { "description": "Returns the applicable max cap per shipping cost for shipping service group1.", "$ref": "#/components/schemas/Amount" }, "group2MaxFlatShippingCost": { "description": "Returns the applicable max cap per shipping cost for shipping service group2.", "$ref": "#/components/schemas/Amount" }, "group3MaxFlatShippingCost": { "description": "Returns the applicable max cap per shipping cost for shipping service group3.", "$ref": "#/components/schemas/Amount" }, "handlingTimeEnabled": { "type": "boolean", "description": "Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup." }, "maxFlatShippingCost": { "description": "The maximum cost the seller can charge for the first domestic flat-rate shipping service. Mutually exclusive with the GroupNMaxFlatShippingCost elements.", "$ref": "#/components/schemas/Amount" }, "shippingTermsRequired": { "type": "boolean", "description": "Indicates whether the category requires sellers to specify shipping details at listing time." } } }, "ShippingService": { "type": "object", "properties": { "description": { "type": "string", "description": "This field returns the localized name of the shipping service." }, "internationalService": { "type": "boolean", "description": "A value of true indicates that the shipping service is international. An international shipping service option is required if an item is being shipped from one country (origin) to another (destination)." }, "maxShippingTime": { "type": "integer", "description": "This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService. ", "format": "int32" }, "minShippingTime": { "type": "integer", "description": "This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService. ", "format": "int32" }, "packageLimits": { "description": "This container provides name-value pairs that specify physical constraints and measurement units of packages for the shippingCarrier and the corresponding shippingService. An empty container is returned if the shipping service does not have any package limits defined.", "$ref": "#/components/schemas/PackageLimits" }, "shippingCarrier": { "type": "string", "description": "The code for the shipping carrier returned, for example, UPS, FedEx, and USPS." }, "shippingCategory": { "type": "string", "description": "The shipping category of the shipping service including: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, and other similar categories." }, "shippingCostTypes": { "type": "array", "description": "A list of shipping cost types that this shipping service option supports. For example, FLAT_RATE, CALCULATED, and FREIGHT.", "items": { "type": "string" } }, "shippingService": { "type": "string", "description": "The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is true. The value returned in this field is used in listing APIs and business policies to set the shipping service." }, "validForSellingFlow": { "type": "boolean", "description": "A value of true indicates that the shippingService can be set as an available shipping service in the listing or through the fulfillment business policy." } }, "description": "This type provides applicable shipping service metadata." }, "ShippingServiceResponse": { "type": "object", "properties": { "shippingServices": { "type": "array", "description": "A complete list of shipping service options that can be used on the marketplace for shipping items.", "items": { "$ref": "#/components/schemas/ShippingService" } } }, "description": "This type provides applicable shipping service metadata returned." }, "SignalWord": { "type": "object", "properties": { "signalWordId": { "type": "string", "description": "The identifier of the signal word. For more information, see Signal word information." }, "signalWordDescription": { "type": "string", "description": "The description of the signal word localized to the default language of the marketplace. For more information, see Signal word information." } }, "description": "A type that describes signal words for hazardous materials labels." }, "SiteVisibilityPoliciesResponse": { "type": "object", "properties": { "siteVisibilityPolicies": { "type": "array", "description": "This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.", "items": { "$ref": "#/components/schemas/SiteVisibilityPolicy" } }, "warnings": { "type": "array", "description": "An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A type that contains eBay international site visibility policy metadata fields." }, "SiteVisibilityPolicy": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which metadata is being returned." }, "categoryTreeId": { "type": "string", "description": "The unique identifier of the category tree." }, "crossBorderTradeAustraliaEnabled": { "type": "boolean", "description": "If true, the category supports specifying that listings of a seller on the UK marketplace can pass in Australia as a value in a field to expose that item on the eBay Australia site (ebay.com.au). For more information, see Cross-border trading." }, "crossBorderTradeGBEnabled": { "type": "boolean", "description": "If true, the category supports specifying that listings of a seller on the US or Canada merketplaces can pass in UK as a value in a field to expose that item on the eBay UK (ebay.co.uk) and eBay IE (ebay.ie) sites. For more information, see Cross-border trading." }, "crossBorderTradeNorthAmericaEnabled": { "type": "boolean", "description": "If true, the category supports specifying that listings of a seller on the US or Canada merketplaces can pass in North America as a value in a field to expose that item on the eBay US (ebay.com) and eBay Canada (ebay.ca) sites (English). For more information, see Cross-border trading. " } }, "description": "A type that contains eBay international cross border trade policy metadata fields." }, "SortOrderInner": { "type": "object", "properties": { "sortOrder": { "description": "This container is used to define the property to be used in the sorting.", "$ref": "#/components/schemas/SortOrderProperties" }, "sortPriority": { "type": "string", "description": "The priority of the specified sort order provided.

For example, when a property is assigned Sort1, its values are sorted first. Values for the property assigned Sort2 are sorted second, and so on.

Valid values:
  • Sort1
  • Sort2
  • Sort3
  • Sort4
  • Sort5
" } }, "description": "This type is used to provide the sort order of compatibility properties returned in the response." }, "SortOrderProperties": { "type": "object", "properties": { "order": { "type": "string", "description": "Defines the order of the sort.

Valid values:
  • Ascending
  • Descending
" }, "propertyName": { "type": "string", "description": "The name of the searchable property to be used for sorting.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category." } }, "description": "This type is used to define the property to be used in sorting. " }, "SpecificationRequest": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.

Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility by specification. For the categories in the response that support compatibility by specification, you’ll see SPECIFICATIONS as the value for the compatibilityBasedOn field " }, "compatibilityPropertyFilters": { "type": "array", "description": "This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response.

Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } }, "dataset": { "type": "string", "description": "This field can be used to define the type of properties that will be returned in the response.

For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.

Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:
  • DisplayableProductDetails: Properties for use in a user interface to describe products.
  • DisplayableSearchResults: Properties for use in results for product searches.
  • Searchable: Properties for use in searches.
  • Sortable: Properties that are suitable for sorting.
Default value: DisplayableSearchResults" }, "datasetPropertyName": { "type": "array", "description": "This comma-delimited array can be used to define the specific property name(s) that will be returned in the response.

For example, if you specify Engine, the result set will only contain engines that are compatible with the input criteria.

Note: This array cannot be used alongside dataset. If both are used, an error will occur.", "items": { "type": "string" } }, "exactMatch": { "type": "boolean", "description": "This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties.

By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input. By specifying this field as true, only exact matches are returned." }, "paginationInput": { "description": "

Important! Pagination is not yet supported by this method. If this container is included in the request, it will be ignored.

", "$ref": "#/components/schemas/PaginationInput" }, "sortOrders": { "type": "array", "description": "This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified.

Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.", "items": { "$ref": "#/components/schemas/SortOrderInner" } }, "specifications": { "type": "array", "description": "This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved.", "items": { "$ref": "#/components/schemas/PropertyFilterInner" } } }, "description": "This type provides the properties and specifications to use to search for compatibilities." }, "SpecificationResponse": { "type": "object", "properties": { "compatibilityDetails": { "type": "array", "description": "This container returns the list of all compatible application name-value pairs for the given filter criteria.", "items": { "$ref": "#/components/schemas/Compatibility" } }, "pagination": { "description": "

Important! Not currently returned. For future use.

", "$ref": "#/components/schemas/Pagination" } }, "description": "This type defines the fields used in the getCompatibilitiesBySpecification response." }, "TimeDuration": { "type": "object", "properties": { "unit": { "type": "string", "description": "A time-measurement unit that specifies a singular period of time.

A span of time is defined when you apply the value specified in the value field to the value specified for unit.

Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation" }, "value": { "type": "integer", "description": "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.", "format": "int32" } }, "description": "A complex type that specifies a period of time using a specified time-measurement unit." } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "clientCredentials": { "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope": "View public data from eBay" } }, "authorizationCode": { "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope/sell.inventory": "View and manage your inventory and offers" } } } } } } }