HsBrowse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/wisepim/json-schema/wisepim-hs-browse-schema.json",
  "title": "HsBrowse",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wisepim-openapi.json#/components/schemas/HsBrowse",
  "type": "object",
  "properties": {
    "market": {
      "type": "string",
      "enum": [
        "eu",
        "us"
      ]
    },
    "language": {
      "type": "string"
    },
    "nomenclature": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "attribution": {
          "type": "string",
          "description": "Credit for the official source; show it with the data."
        }
      }
    },
    "node": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "allOf": [
            {
              "$ref": "#/$defs/HsCode"
            },
            {
              "type": "object",
              "properties": {
                "note": {
                  "type": "string"
                },
                "path": {
                  "type": "array",
                  "items": {
                    "$ref": "#/$defs/HsCode"
                  }
                }
              }
            }
          ]
        }
      ]
    },
    "children": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "$ref": "#/$defs/HsCode"
          },
          {
            "type": "object",
            "properties": {
              "hasChildren": {
                "type": "boolean"
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              }
            }
          }
        ]
      }
    },
    "attribution": {
      "$ref": "#/$defs/Attribution"
    }
  },
  "$defs": {
    "Attribution": {
      "type": "object",
      "description": "Credit to show wherever the data appears: a visible link with the text \"Data by WISEPIM\" to `url`.",
      "required": [
        "required",
        "text",
        "url",
        "html",
        "markdown",
        "terms"
      ],
      "properties": {
        "required": {
          "type": "boolean",
          "const": true
        },
        "text": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "html": {
          "type": "string"
        },
        "markdown": {
          "type": "string"
        },
        "terms": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "HsCode": {
      "type": "object",
      "required": [
        "code",
        "formatted",
        "level",
        "description"
      ],
      "properties": {
        "code": {
          "type": "string"
        },
        "formatted": {
          "type": "string"
        },
        "level": {
          "type": "integer",
          "minimum": 2,
          "maximum": 10
        },
        "description": {
          "type": "string"
        }
      }
    }
  }
}