eBay · Schema

CompatibilityResponse

The type that defines the response fields for checkCompatibility.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
compatibilityStatus string An enumeration value that tells you if the item is compatible with the product.

The values are:
  • COMPATIBLE - Indicates the item is compatible with the product specified in th
warnings array An array of warning messages. These types of errors do not prevent the method from executing but should be checked.
View JSON Schema on GitHub

JSON Schema

ebay-compatibilityresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompatibilityResponse",
  "title": "CompatibilityResponse",
  "type": "object",
  "properties": {
    "compatibilityStatus": {
      "type": "string",
      "description": "An enumeration value that tells you if the item is compatible with the product. <br><br>The values are: <ul>   <li>   <b> COMPATIBLE</b> - Indicates the item is compatible with the product specified in the request.</li>   <li>   <b> NOT_COMPATIBLE</b> - Indicates the item is not compatible with the product specified in the request. Be sure to check all the <b> value</b> fields to ensure they are correct as errors in the value can also cause this response.</li>   <li> <b> UNDETERMINED</b> - Indicates one or more attributes for the specified product are missing so compatibility cannot be determined.  The response returns the attributes that are missing.</li>  </ul>  Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityStatus'>eBay API documentation</a>"
    },
    "warnings": {
      "type": "array",
      "description": "An array of warning messages. These types of errors do not prevent the method from executing but should be checked.",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    }
  },
  "description": "The type that defines the response fields for <b> checkCompatibility</b>.  "
}