{
  "$id": "https://www.hestia.earth/schema-data/json-schema/Product.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$comment": "Schema version 39.0.1",
  "title": "Product",
  "description": "A Product created during a [Cycle](/schema/Cycle) or [Transformation](/schema/Transformation). Each Product must be unique, and the fields which determine uniqueness are defined in the <code>[products](/schema/Cycle#products)</code> field of the Cycle or [Transformation](/schema/Transformation#products).\n",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of the Node",
      "default": "Product",
      "enum": [
        "Product"
      ]
    },
    "@type": {
      "type": "string",
      "description": "Type of the Node",
      "default": "Product",
      "enum": [
        "Product"
      ],
      "extend": true
    },
    "term": {
      "$ref": "./Term-deep.json#",
      "description": "A reference to the Term describing the Product.",
      "examples": [
        {
          "@id": "wheatGrain",
          "@type": "Term",
          "name": "Wheat, grain",
          "units": "kg",
          "termType": "crop"
        }
      ],
      "searchable": true,
      "exportDefaultCSV": true
    },
    "description": {
      "type": "string",
      "description": "A short description of the Product.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "variety": {
      "type": "string",
      "description": "The variety (cultivar) of a crop or breed of animal. Standardised variety names are defined in external glossaries, such as the OECD, GEVES, PLUTO, or CPVO glossaries.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "value": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "description": "The quantity of the Product. If an average, it should always be the mean. Can be a single number (array of length one) or an array of numbers with associated dates (e.g., for multiple harvests in one Cycle]). The units are always specified in the [Term. For crops, value should always be per harvest or per year, following FAOSTAT conventions.",
      "examples": [
        [
          7282
        ]
      ],
      "minimum": 0,
      "exportDefaultCSV": true,
      "recommended": true,
      "searchable": true
    },
    "distribution": {
      "type": "array",
      "items": {
        "type": [
          "number",
          "array"
        ]
      },
      "description": "An array of up to 1000 random samples from the posterior distribution of valuedates field.",
      "examples": [],
      "exportDefaultCSV": true,
      "maxItems": 1000
    },
    "sd": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "description": "The standard deviation of value.",
      "examples": [],
      "minimum": 0,
      "arraySameSize": [
        "value"
      ],
      "exportDefaultCSV": true
    },
    "min": {
      "type": "array",
      "items": {
        "type": [
          "number",
          "null"
        ]
      },
      "description": "The minimum of value.",
      "examples": [],
      "arraySameSize": [
        "value"
      ],
      "exportDefaultCSV": true
    },
    "max": {
      "type": "array",
      "items": {
        "type": [
          "number",
          "null"
        ]
      },
      "description": "The maximum of value.",
      "examples": [],
      "arraySameSize": [
        "value"
      ],
      "exportDefaultCSV": true
    },
    "percentile10th": {
      "type": "number",
      "description": "The 10th percentile of value.",
      "examples": [],
      "exportDefaultCSV": false,
      "internal": true
    },
    "percentile90th": {
      "type": "number",
      "description": "The 90th percentile of value.",
      "examples": [],
      "exportDefaultCSV": false,
      "internal": true
    },
    "statsDefinition": {
      "type": "string",
      "description": "What the descriptive statistics (sd, min, max, and value) are calculated across, or whether they are simulated or the output of a model. spatial refers to descriptive statistics calculated across spatial units (e.g., pixels) within a region or country. time refers to descriptive statistics calculated across units of time (e.g., hours).",
      "examples": [],
      "enum": [
        "sites",
        "cycles",
        "replications",
        "animals",
        "other observations",
        "time",
        "spatial",
        "regions",
        "simulated",
        "modelled"
      ],
      "exportDefaultCSV": true
    },
    "observations": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 1
          },
          {
            "type": "null"
          }
        ]
      },
      "description": "The number of observations the descriptive statistics are calculated over.",
      "examples": [],
      "searchable": true,
      "minimum": 1,
      "arraySameSize": [
        "value"
      ],
      "exportDefaultCSV": true
    },
    "dates": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A corresponding array to value, representing the dates of the Products in ISO 8601 format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM, or YYYY-MM-DDTHH:mm:ssZ).",
      "examples": [],
      "dateTimePattern": true,
      "arraySameSize": [
        "value"
      ],
      "exportDefaultCSV": true
    },
    "startDate": {
      "type": "string",
      "description": "For Products created over periods, the start date of the Product if different from the start date of the Cycle in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).",
      "examples": [],
      "datePattern": true,
      "exportDefaultCSV": true
    },
    "endDate": {
      "type": "string",
      "description": "For Products created over periods, the end date of the Product if different from the end date of the Cycle in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).",
      "examples": [],
      "datePattern": true,
      "exportDefaultCSV": true
    },
    "methodClassification": {
      "type": "string",
      "description": "A classification of the method used to acquire or estimate the term and value. Overrides the defaultMethodClassification specified in the Cycle. methodClassification should be specified separately for properties (see Property) and transport (see Transport).    physical measurement means the amount is quantified using weighing,\n    volume measurement, metering, chemical methods, or other physical approaches.\n\n    verified survey data means the data are initially collected through\n    surveys; all or a subset of the data are verified using physical methods; and\n    erroneous survey data are discarded or corrected.\n\n    non-verified survey data means the data are collected through\n    surveys that have not been subjected to verification.\n\n    modelled means a previously calibrated model is used to estimate\n    this data point from other data points describing this Cycle.\n\n    estimated with assumptions means a documented assumption is used\n    to estimate this data point from other data points describing this Cycle.\n\n    consistent external sources means the data are taken from external\n    datasets referring to different producers/enterprises:\n\n        Using the same technology (defined as the same\n        System or the same key Practices\n        as those specified in the Cycle);\n\n        At the same date (defined as occurring within the\n        startDate and endDate of the Cycle);\n        and\n\n        In the same region or country.\n\n    Modelling or assumptions may have also been used to transform these data.\n\n    inconsistent external sources means the data are taken from external\n    datasets referring to different producers/enterprises:\n\n        Using a different technology (defined as a different\n        System or using different key\n        Practices to those specified in the Cycle);\n\n        At a different date (defined as occurring within the\n        startDate and endDate of the Cycle);\n        or\n\n        In a different region or country.\n\n    Modelling or assumptions may have also been used to transform these data.\n\n    expert opinion means the data have been estimated by experts in\n    the field.\n\n    unsourced assumption means the data do not have a clear source\n    and/or are based on assumptions only.\n",
      "examples": [],
      "enum": [
        "physical measurement",
        "verified survey data",
        "non-verified survey data",
        "modelled",
        "estimated with assumptions",
        "consistent external sources",
        "inconsistent external sources",
        "expert opinion",
        "unsourced assumption"
      ],
      "searchable": true,
      "exportDefaultCSV": true
    },
    "methodClassificationDescription": {
      "type": "string",
      "description": "A justification of the methodClassification used. If the data were estimated with assumptions this field should also describe the assumptions. This is a required field if methodClassification is specified.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "model": {
      "$ref": "./Term-deep.json#",
      "description": "A reference to the Term describing the model used to estimate these data.",
      "examples": [],
      "searchable": true,
      "exportDefaultCSV": true
    },
    "modelDescription": {
      "type": "string",
      "description": "A free text field, describing the model used to estimate these data.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "fate": {
      "type": "string",
      "description": "The fate of the Product. Use Transformations where possible to represent the conversion of one Product into another.",
      "examples": [],
      "enum": [
        "sold",
        "sold to export market",
        "sold to domestic market",
        "sold for breeding",
        "sold for fattening",
        "sold for slaughter",
        "home consumption",
        "fodder",
        "bedding",
        "breeding",
        "saved for seeds",
        "processing",
        "burnt for fuel",
        "burnt",
        "anaerobic digestion",
        "composted",
        "used as fertiliser",
        "used as soil amendment",
        "used as mulch"
      ],
      "exportDefaultCSV": true
    },
    "price": {
      "type": "number",
      "minimum": 0,
      "description": "The sale price of this Product. The price should be expressed per the units defined in the term, for example per \"kg liveweight\". The currency must be specified.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "priceSd": {
      "type": "number",
      "minimum": 0,
      "description": "The standard deviation of price.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "priceMin": {
      "type": "number",
      "minimum": 0,
      "description": "The minimum of price.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "priceMax": {
      "type": "number",
      "minimum": 0,
      "description": "The maximum of price.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "priceStatsDefinition": {
      "type": "string",
      "description": "What the descriptive statistics for price are calculated across.",
      "examples": [],
      "enum": [
        "cycles",
        "time",
        "cycles and time"
      ],
      "exportDefaultCSV": true
    },
    "revenue": {
      "type": "number",
      "minimum": 0,
      "description": "The total revenue (price x quantity) of this Product. The currency must be specified.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "revenueSd": {
      "type": "number",
      "minimum": 0,
      "description": "The standard deviation of revenue.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "revenueMin": {
      "type": "number",
      "minimum": 0,
      "description": "The minimum of revenue.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "revenueMax": {
      "type": "number",
      "minimum": 0,
      "description": "The maximum of revenue.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "revenueStatsDefinition": {
      "type": "string",
      "description": "What the descriptive statistics for revenue are calculated across.",
      "examples": [],
      "enum": [
        "cycles",
        "time",
        "cycles and time"
      ],
      "exportDefaultCSV": true
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "The three letter currency code in ISO 4217 format.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "economicValueShare": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "The economic value (typically revenue) of this Product, divided by the total economic value of all Products, expressed as a percentage.",
      "examples": [
        94.8
      ],
      "exportDefaultCSV": true
    },
    "primary": {
      "type": "boolean",
      "description": "Where the are multiple products, whether this product is the primary product. Defaults to true if there is only one product or if economicValueShare > 50.",
      "examples": [],
      "searchable": true,
      "exportDefaultCSV": true
    },
    "source": {
      "$ref": "./Source-deep.json#",
      "description": "A reference to the Source of these data, if different from the defaultSource of the Cycle.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "otherSources": {
      "type": "array",
      "items": {
        "$ref": "./Source-deep.json#"
      },
      "description": "A list of references to any other sources of these data.",
      "examples": [],
      "exportDefaultCSV": true
    },
    "properties": {
      "type": "array",
      "items": {
        "$ref": "./Property.json#"
      },
      "description": "A list of Properties of the Product, which would override any default properties specified in the term. For crops, dry matter is a default property of the Term and can be changed by adding dry matter here.",
      "examples": [
        [
          {
            "@type": "Property",
            "term": {
              "@id": "dryMatter",
              "@type": "Term",
              "name": "Dry matter",
              "units": "%",
              "termType": "property"
            },
            "value": 80
          }
        ]
      ],
      "exportDefaultCSV": true,
      "uniqueArrayItem": [
        "term.@id",
        "key.@id",
        "value",
        "share",
        "date",
        "startDate",
        "endDate"
      ]
    },
    "transport": {
      "type": "array",
      "items": {
        "$ref": "./Transport.json#"
      },
      "description": "A list of Transport stages to take this Product to the final location within the Site. For example, the Transport required to take harvested crops from the field to the barn where they are stored before being sold.",
      "examples": [],
      "exportDefaultCSV": true,
      "uniqueArrayItem": [
        "term.@id",
        "value",
        "distance"
      ]
    },
    "schemaVersion": {
      "type": "string",
      "description": "The version of the schema when these data were created.",
      "examples": [],
      "internal": true
    },
    "added": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of fields that have been added to the original dataset.",
      "examples": [],
      "internal": true
    },
    "addedVersion": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of versions of the model used to add these fields.",
      "examples": [],
      "internal": true
    },
    "updated": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of fields that have been updated on the original dataset.",
      "examples": [],
      "internal": true
    },
    "updatedVersion": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of versions of the model used to update these fields.",
      "examples": [],
      "internal": true
    },
    "aggregated": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of fields that have been 'aggregated' using data from multiple Cycles.",
      "examples": [],
      "internal": true
    },
    "aggregatedVersion": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of versions of the aggregation engine corresponding to each aggregated field.",
      "examples": [],
      "internal": true
    },
    "revenueRatio": {
      "type": "number",
      "minimum": 0,
      "description": "The ratio of the total revenue (adjusted price x quantity) of this Product compared to the Product that is the focus of the aggregation. The adjusted price is the price of the Product divided by the price of the Product that is the focus of an aggregation.",
      "examples": [],
      "internal": true
    }
  },
  "allOf": [
    {
      "if": {
        "required": [
          "term"
        ]
      },
      "then": {
        "properties": {
          "term": {
            "properties": {
              "termType": {
                "enum": [
                  "animalProduct",
                  "crop",
                  "aquaticCrop",
                  "cropResidue",
                  "electricity",
                  "feedFoodAdditive",
                  "forage",
                  "fuel",
                  "liveAnimal",
                  "liveAquaticSpecies",
                  "excreta",
                  "organicFertiliser",
                  "inorganicFertiliser",
                  "biochar",
                  "otherOrganicChemical",
                  "otherInorganicChemical",
                  "processingAid",
                  "processedFood",
                  "seed",
                  "soilAmendment",
                  "substrate",
                  "material",
                  "waste"
                ]
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "required": [
          "model"
        ]
      },
      "then": {
        "properties": {
          "model": {
            "properties": {
              "termType": {
                "enum": [
                  "model"
                ]
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "anyOf": [
          {
            "required": [
              "min"
            ]
          },
          {
            "required": [
              "max"
            ]
          },
          {
            "required": [
              "sd"
            ]
          }
        ]
      },
      "then": {
        "required": [
          "statsDefinition"
        ]
      }
    },
    {
      "if": {
        "required": [
          "statsDefinition"
        ]
      },
      "then": {
        "anyOf": [
          {
            "required": [
              "value"
            ]
          },
          {
            "required": [
              "min"
            ]
          },
          {
            "required": [
              "max"
            ]
          },
          {
            "required": [
              "sd"
            ]
          }
        ]
      }
    },
    {
      "if": {
        "anyOf": [
          {
            "required": [
              "revenue"
            ]
          },
          {
            "required": [
              "price"
            ]
          }
        ]
      },
      "then": {
        "required": [
          "currency"
        ]
      }
    },
    {
      "if": {
        "required": [
          "methodClassification"
        ]
      },
      "then": {
        "required": [
          "methodClassificationDescription"
        ]
      }
    },
    {
      "if": {
        "anyOf": [
          {
            "required": [
              "priceMin"
            ]
          },
          {
            "required": [
              "priceMax"
            ]
          },
          {
            "required": [
              "priceSd"
            ]
          }
        ]
      },
      "then": {
        "required": [
          "priceStatsDefinition"
        ]
      }
    },
    {
      "if": {
        "anyOf": [
          {
            "required": [
              "revenueMin"
            ]
          },
          {
            "required": [
              "revenueMax"
            ]
          },
          {
            "required": [
              "revenueSd"
            ]
          }
        ]
      },
      "then": {
        "required": [
          "revenueStatsDefinition"
        ]
      }
    }
  ],
  "oneOf": [
    {
      "required": [
        "@type"
      ]
    },
    {
      "required": [
        "type"
      ]
    }
  ],
  "required": [
    "term"
  ]
}