HarmonizedCodeSearchRequestVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-harmonized-code-search-request-vo-schema.json",
  "title": "HarmonizedCodeSearchRequestVO",
  "description": "These are the harmonized code search request 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/HarmonizedCodeSearchRequestVO",
  "type": "object",
  "properties": {
    "hsClassify": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/HsClassifyVO"
      }
    }
  },
  "$defs": {
    "HsClassifyVO": {
      "required": [
        "commodityDescription",
        "destinationCountryCodes",
        "originCountryCode"
      ],
      "type": "object",
      "properties": {
        "commodityName": {
          "maxLength": 256,
          "type": "string",
          "description": "The name of the commodity"
        },
        "commodityDescription": {
          "maxLength": 512,
          "type": "string",
          "description": "Commodity description that would describe the commodity."
        },
        "destinationCountryCodes": {
          "type": "array",
          "description": "List of destination country codes for the classification. Either originCountryCode or destinationCountryCodes is mandatory",
          "items": {
            "maxLength": 2,
            "type": "string"
          }
        },
        "originCountryCode": {
          "maxLength": 2,
          "type": "string",
          "description": "The country of origin code for the commodity.  Either originCountryCode or destinationCountryCodes is mandatory"
        },
        "countryOfManufacture": {
          "maxLength": 2,
          "type": "string",
          "description": "The country code where the commodity was manufactured."
        },
        "productId": {
          "maxLength": 100,
          "type": "string",
          "description": "sku of the commodity"
        },
        "categories": {
          "type": "array",
          "description": "List of categories associated with the commodity.",
          "items": {
            "type": "string"
          }
        },
        "material": {
          "type": "string",
          "description": "The material composition of the commodity for classification. e.g., plastic, wood, steel"
        },
        "unitPrice": {
          "$ref": "#/$defs/UnitPriceVO"
        }
      },
      "description": "These are the details required to classify a commodity for a harmonized code search.",
      "maxProperties": 10
    },
    "UnitPriceVO": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "description": "The numeric value of the unit price.",
          "format": "double"
        },
        "currency": {
          "type": "string",
          "description": "The currency code associated with the price (e.g., USD)."
        }
      },
      "description": "Represents the monetary value per unit of the commodity."
    }
  }
}