GET/marketplace/{marketplace_id}/get_motors_listing_policies
This method returns eBay Motors policy metadata for all leaf categories on the specified marketplace.
By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body.
Note: To return policy information for eBay US Motors categories, specify marketplace_id as EBAY_MOTORS_US.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | string | 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. Occurrence: Required |
| filter | string | 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} Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| motorsListingPolicies | array of MotorsListingPolicy | 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. Occurrence: Always |
| motorsListingPolicies.categoryId | string | The unique identifier of the eBay leaf category for which metadata is being returned. Occurrence: Always |
| motorsListingPolicies.categoryTreeId | string | The unique identifier of the category tree. Occurrence: Always |
| motorsListingPolicies.depositSupported | boolean | This field is returned as Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProAdFormatEnabled | AdFormatEnabledEnum | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProAutoAcceptEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProAutoDeclineEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProBestOfferEnabled | ClassifiedAdBestOfferEnabledEnum | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProCompanyNameEnabled | boolean | Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProContactByAddressEnabled | boolean | Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProContactByEmailEnabled | boolean | Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProContactByPhoneEnabled | boolean | Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProCounterOfferEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProPaymentMethodCheckOutEnabled | ClassifiedAdPaymentMethodEnabledEnum | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProPhoneCount | integer | Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProSellerContactDetailsEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProShippingMethodEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.ebayMotorsProStreetCount | integer | This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users. Occurrence: Conditional |
| motorsListingPolicies.epidSupported | boolean | If returned as Occurrence: Conditional |
| motorsListingPolicies.localListingDistances | array of LocalListingDistance | 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. Occurrence: Conditional |
| motorsListingPolicies.localListingDistances.distances | array of integer | This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings. Occurrence: Conditional |
| motorsListingPolicies.localListingDistances.distanceType | DistanceType | This enumerated value indicates the type of local listing distances, such as non-subscription or regular, for items listed by sellers. Occurrence: Conditional |
| motorsListingPolicies.localMarketAdFormatEnabled | AdFormatEnabledEnum | Specifies whether this category supports Motor Local Market Classified Ad listings. Occurrence: Conditional |
| motorsListingPolicies.localMarketAutoAcceptEnabled | boolean | Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads. Occurrence: Conditional |
| motorsListingPolicies.localMarketAutoDeclineEnabled | boolean | Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads. Occurrence: Conditional |
| motorsListingPolicies.localMarketBestOfferEnabled | ClassifiedAdBestOfferEnabledEnum | Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category. Occurrence: Conditional |
| motorsListingPolicies.localMarketCompanyNameEnabled | boolean | Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads. Occurrence: Conditional |
| motorsListingPolicies.localMarketContactByAddressEnabled | boolean | Indicates whether this category supports including the address in the seller's contact information. Occurrence: Conditional |
| motorsListingPolicies.localMarketContactByEmailEnabled | boolean | Indicates whether the category supports including an email address in the seller's contact information. Occurrence: Conditional |
| motorsListingPolicies.localMarketContactByPhoneEnabled | boolean | Indicates whether this category supports including the telephone in the seller's contact information. Occurrence: Conditional |
| motorsListingPolicies.localMarketCounterOfferEnabled | boolean | Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings. Occurrence: Conditional |
| motorsListingPolicies.localMarketNonSubscription | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.localMarketPaymentMethodCheckOutEnabled | ClassifiedAdPaymentMethodEnabledEnum | 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. Occurrence: Conditional |
| motorsListingPolicies.localMarketPhoneCount | integer | Indicates the number of phone numbers that can be included through contact information for this category. Occurrence: Conditional |
| motorsListingPolicies.localMarketPremiumSubscription | boolean | Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers. Occurrence: Conditional |
| motorsListingPolicies.localMarketRegularSubscription | boolean | Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers. Occurrence: Conditional |
| motorsListingPolicies.localMarketSellerContactDetailsEnabled | boolean | Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings. Occurrence: Conditional |
| motorsListingPolicies.localMarketShippingMethodEnabled | boolean | 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. Occurrence: Conditional |
| motorsListingPolicies.localMarketSpecialitySubscription | boolean | Indicates whether the category supports the Speciality level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers. Occurrence: Conditional |
| motorsListingPolicies.localMarketStreetCount | integer | Indicates which address option is enabled for the seller's contact information. Occurrence: Conditional |
| motorsListingPolicies.maxGranularFitmentCount | integer | 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. Occurrence: Conditional |
| motorsListingPolicies.maxItemCompatibility | integer | specifies the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually ( Item.ItemCompatibilityList) only. Occurrence: Conditional |
| motorsListingPolicies.nonSubscription | GeographicExposureEnum | The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription. Occurrence: Conditional |
| motorsListingPolicies. | GeographicExposureEnum | Occurrence: Conditional |
| motorsListingPolicies.regularSubscription | GeographicExposureEnum | The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription. Occurrence: Conditional |
| motorsListingPolicies.sellerProvidedTitleSupported | boolean | This field is returned as Occurrence: Conditional |
| motorsListingPolicies.specialitySubscription | GeographicExposureEnum | The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription. Occurrence: Conditional |
| motorsListingPolicies.vinSupported | boolean | Indicates if Vehicle Identification Number is supported. Occurrence: Conditional |
| motorsListingPolicies.vrmSupported | boolean | Indicates if Vehicle Registration Mark is supported. Occurrence: Conditional |
| warnings | array of ErrorDetailV3 | 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. Occurrence: Conditional |
| warnings.category | string | The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:
Occurrence: Conditional |
| warnings.domain | string | Name of the domain containing the service or application. Occurrence: Conditional |
| warnings.errorId | integer | 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. Occurrence: Conditional |
| warnings.inputRefIds | array of string | Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. Occurrence: Conditional |
| warnings.longMessage | string | An expanded version of message that should be around 100-200 characters long, but is not required to be such. Occurrence: Conditional |
| warnings.message | string | 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. Occurrence: Conditional |
| warnings.outputRefIds | array of string | Identifies specific response elements associated with the error, if any. Path format is the same as Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | This optional complex field type contains a list of one or more context-specific Occurrence: Conditional |
| warnings.parameters.name | string | Name of the entity that threw the error. Occurrence: Conditional |
| warnings.parameters.value | string | A description of the error. Occurrence: Conditional |
| warnings.subdomain | string | Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 204 | No content |
| 400 | Bad Request |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46000 | API_METADATA | APPLICATION | There was a problem with an eBay internal system or process.Contact eBay developer support for assistance. |
| 46001 | API_METADATA | REQUEST | The specified marketplace ID was not found. |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46002 | API_METADATA | REQUEST | The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}. |
| 46003 | API_METADATA | REQUEST | The specified categoryId was not found for the marketplace. |
| 46004 | API_METADATA | REQUEST | Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter. |
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get the eBay Motors policy metadata for a specified marketplace
This example retrieves the eBay Motors policies for the two specified leaf categories, 98063 and 84159.
This method returns an array of leaf categories from the category tree of the specified marketplace. Each node in the response contains metadata for the motors listing policies in each returned category.
Input
This method does not use a request payload. This sample uses the parameter: filter=categoryIds:{98063|84159}
GEThttps://api.ebay.com/sell/metadata/v1/marketplace/EBAY_US/get_motors_listing_policies?filter=categoryIds:{98063|84159}
Output
If the call is successful, the response body contains the eBay Motors policy metadata of the marketplace for the categories specified in the request.