addedInput schema / properties / customs_codes
Added value: +{
+ "anyOf": [
+ {
+ "items": {
+ "description": "A canonical customs code, TOTAL, or a supported residual spelling.",
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Customs code(s) to check coverage for. Omit for the overall store range."
+}
addedOutput schema / properties
Added value: +{
+ "result": {
+ "additionalProperties": false,
+ "description": "GET /api/reference/data-range — cached period coverage ('YYYY-MM').",
+ "properties": {
+ "data_max": {
+ "anyOf": [
+ {
+ "description": "A calendar month, 'YYYY-MM'.",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The last month with data in the local store, over the codes' raw declarations."
+ },
+ "data_min": {
+ "anyOf": [
+ {
+ "description": "A calendar month, 'YYYY-MM'.",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The first month with data in the local store, over the codes' raw declarations (every definition)."
+ },
+ "selection": {
+ "description": "For each piece given (the basket request form), the coverage of its window -- separate from the raw base coverage above.",
+ "items": {
+ "additionalProperties": false,
+ "description": "The stored coverage of one piece: the months holding data inside its\nwindow, so gaps between definitions stay visible.",
+ "properties": {
+ "customs_code": {
+ "description": "The piece's customs code.",
+ "type": "string"
+ },
+ "from_month": {
+ "anyOf": [
+ {
+ "description": "A calendar month, 'YYYY-MM'.",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The window's first month, ISO 'YYYY-MM'; null = the store coverage start."
+ },
+ "to_month": {
+ "anyOf": [
+ {
+ "description": "A calendar month, 'YYYY-MM'.",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The window's last month, ISO 'YYYY-MM'; null = the store coverage end."
+ },
+ "windows": {
+ "description": "The months holding data inside the piece's window; an empty list means nothing is stored there.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "data_max": {
+ "description": "The last month with data inside the window ('YYYY-MM').",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ },
+ "data_min": {
+ "description": "The first month with data inside the window ('YYYY-MM').",
+ "pattern": "\\d{4}-\\d{2}",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data_min",
+ "data_max"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "customs_code",
+ "from_month",
+ "to_month",
+ "windows"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+}