eBay · Schema

ItemConditionDescriptor

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.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
conditionDescriptorConstraint object 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.
conditionDescriptorHelpText string 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 string The unique identification number of a condition descriptor associated with with a conditionDescriptorName.

For example, 40001 is the ID for Card Condition.
conditionDescriptorName string The human-readable label for the condition descriptor associated with the conditionDescriptorID.

For example, Card Condition is the condition descriptor name for ID 4
conditionDescriptorValues array 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 I
View JSON Schema on GitHub

JSON Schema

ebay-itemconditiondescriptor-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemConditionDescriptor",
  "title": "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.<br><br> For example, the help text for <code>Card Condition</code> is <code>Select ungraded condition</code>."
    },
    "conditionDescriptorId": {
      "type": "string",
      "description": "The unique identification number of a condition descriptor associated with with a <b>conditionDescriptorName</b>. <br><br>For example, <code>40001</code> is the ID for <code>Card Condition</code>.<br><br>These IDs are used in the addItem family of calls of the <b>Trading API</b> to provide condition descriptor names for the item. These IDs are used by the inventoryItem family of calls of the <b>Inventory API</b> to provide condition descriptor names for the item."
    },
    "conditionDescriptorName": {
      "type": "string",
      "description": "The human-readable label for the condition descriptor associated with the <b>conditionDescriptorID</b>. <br><br>For example, <code>Card Condition</code> is the condition descriptor name for ID <code>40001</code>"
    },
    "conditionDescriptorValues": {
      "type": "array",
      "description": "This array shows the possible values that map to the corresponding <b>conditionDescriptorName</b> values. Constraint information and help text are also shown for each value. <br><br>For example, The ID <code>40001</code> is ID for the condition descriptor <code>card condition</code>. The ID <code>400012</code> is the ID for the <code>Very Good</code> 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."
}