POST/compatibilities/get_compatibility_property_names
This method is used to retrieve product compatibility property names for the specified compatibility-enabled category.
Compatibility property names can be used alongside the corresponding compatibility property value (retrieved using the getCompatibilityPropertyValues method) to describe the assembly for which an item is compatible.
The categoryId of the compatibility-enabled category for which to retrieve compatibility property names is required in the request body.
By default, all property names within the compatibility category of the specified compatibility-enable category are returned. You can limit the size of the result set by using the dataset array to specify the types of properties you want returned.
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
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | 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. Occurrence: Required |
| X-EBAY-C-MARKETPLACE-ID | string | This header identifies the seller's eBay marketplace. See Metadata API requirements and restrictions for supported values. Occurrence: Required |
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
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| categoryId | string | 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. Occurrence: Required |
| dataset | array of string | This array defines the properties that will be returned for the compatibility-enabled category.
DisplayableSearchResults Occurrence: Optional |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| categoryId | string | The unique identifier of the eBay category specified in the request. Occurrence: Always |
| properties | array of PropertyNamesResponseProperties | This array contains all of the properties for the specified category. Occurrence: Always |
| properties.dataset | string | This field defines the types of properties are returned for the specified catalog-enabled category.
Occurrence: Conditional |
| properties.propertyNames | array of PropertyNamesResponsePropertyNames | This array specifies the names of the properties associated with the specified category in the specified marketplace. Occurrence: Conditional |
| properties.propertyNames.propertyDisplayName | string | The display name of a property. This is the localized name of the compatible property. Occurrence: Conditional |
| properties.propertyNames.propertyName | string | The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility. Occurrence: Conditional |
| properties.propertyNames.propertyNameMetadata | PropertyNamesResponsePropertyNameMetadata | The metadata for a property. Occurrence: Conditional |
| properties.propertyNames.propertyNameMetadata.displaySequence | integer | The numeric value indicating the ordering position of the property. 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 |
| 401 | Unauthorized |
| 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 | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 47000 | API | REQUEST | Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter. |
| 47001 | API | REQUEST | The category {{category_id}} specified in the request is not a valid eBay category for the marketplace. |
| 47002 | API | REQUEST | The category {{category_id}} specified in the request does not support compatibilities. |
| 47003 | API | REQUEST | A required field is missing from the request. |
| 47004 | API | REQUEST | Invalid data supplied in the request. |
| 47005 | API | REQUEST | The marketplace id {{marketplaceId}} specified in the request is invalid. |
| 47006 | API | REQUEST | The marketplace id {{marketplaceId}} specified in the request does not support compatibility. |
Warnings
This call has no warnings.
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: Retrieve product compatibility names for a category
This method will retrieve product compatibility property names for a specified compatibility-enabled category.
Input
The category ID for which to retrieve compatibility property names must be provided in the request body. The dataSet array can also be set to define the properties that will be returned.
In this sample, DisplayableSearchResults is defined, which means that only properties for use in results for product searches are returned.
POSThttps://api.ebay.com/sell/metadata/v1/compatibilities/get_compatibility_property_names
Output
If the call is successful, all property names (within the confines of the specified dataSet) for the specified category are returned, along with the associated metadata and the display name of the property.