HarmonizedCodeSearchResponseVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-harmonized-code-search-response-vo-schema.json",
  "title": "HarmonizedCodeSearchResponseVO",
  "description": "These are the harmonized code search response details.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-harmonized-code-api-openapi.yml#/components/schemas/HarmonizedCodeSearchResponseVO",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is a special set of numbers that defines each transaction."
    },
    "customerTransactionId": {
      "type": "string",
      "description": "This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply"
    },
    "output": {
      "$ref": "#/$defs/HarmonizedCodeOutputVO"
    }
  },
  "$defs": {
    "HarmonizedCodeOutputVO": {
      "type": "object",
      "properties": {
        "hsClassifications": {
          "type": "array",
          "description": "Indicates the Harmonized system search summaries.",
          "items": {
            "$ref": "#/$defs/SummaryVO"
          }
        }
      },
      "description": "These are all the harmonized search response details."
    },
    "SubheadingAlternatesVO": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the commodity"
        },
        "code": {
          "type": "string",
          "description": "The alternative Harmonized System (HS) code."
        },
        "description": {
          "type": "string",
          "description": "Description of the commodity associated with this alternative code."
        },
        "confidenceScore": {
          "type": "number",
          "description": "The numerical score indicating the system's confidence in this specific classification.",
          "format": "double"
        },
        "tarriffAlternates": {
          "maxItems": 4,
          "type": "array",
          "description": "A list of tarriff alternattes",
          "items": {
            "$ref": "#/$defs/TarriffAlternatesVO"
          }
        }
      },
      "description": "An Subheading classification option provided by the system."
    },
    "SummaryVO": {
      "type": "object",
      "properties": {
        "countryCode": {
          "type": "string",
          "description": "The ISO country code associated with this classification."
        },
        "countryType": {
          "type": "string",
          "description": "Specifies if the country is the origin or the destination.<br>Valid values: DESTINATION, ORIGIN",
          "enum": [
            "DESTINATION",
            "ORIGIN"
          ]
        },
        "subheadingOptions": {
          "maxItems": 4,
          "type": "array",
          "description": "A list of subheading alternattes",
          "items": {
            "$ref": "#/$defs/SubheadingAlternatesVO"
          }
        }
      },
      "description": "Summary information for a specific harmonized code search result."
    },
    "TarriffAlternatesVO": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the commodity"
        },
        "code": {
          "type": "string",
          "description": "The alternative Harmonized System (HS) code."
        },
        "description": {
          "type": "string",
          "description": "Description of the commodity associated with this alternative code."
        }
      },
      "description": "An Tarriff alternative classification option provided by the system."
    }
  }
}