{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/postnl/json-schema/postnl-labelling-response-schema.json",
  "title": "labellingResponse",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postnl-labelling-api-openapi.yml#/components/schemas/labellingResponse",
  "type": "object",
  "properties": {
    "MergedLabels": {
      "type": "array",
      "description": "The merged label output; only returned if the printer type selected in your request merges the pdf labels into a single file (e.g. using GraphicFile|Merge).",
      "items": {
        "$ref": "#/$defs/labellingMergedLabel"
      }
    },
    "ResponseShipments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/labellingResponseShipment"
      }
    }
  },
  "$defs": {
    "labellingLabel": {
      "type": "object",
      "properties": {
        "Content": {
          "type": "string",
          "description": "Base64 encoded label content"
        },
        "Labeltype": {
          "type": "string",
          "description": "Type of the label. See possible [Label types](https://developer.postnl.nl/docs/#/http/reference-data/reference-codes/label-types)"
        },
        "OutputType": {
          "type": "string",
          "description": "Content type of the label, e.g. zebra of pdf."
        }
      }
    },
    "labellingMergedLabel": {
      "type": "object",
      "properties": {
        "Barcodes": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Array of barcodes used in the shipment"
          }
        },
        "Labels": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/labellingLabel"
          }
        }
      }
    },
    "labellingResponseShipment": {
      "type": "object",
      "properties": {
        "ProductCodeDelivery": {
          "type": "string",
          "description": "The product code of the shipment"
        },
        "Labels": {
          "type": "array",
          "description": "All labels belonging to the selected product",
          "items": {
            "$ref": "#/$defs/labellingLabel"
          }
        },
        "Barcode": {
          "type": "string",
          "description": "The barcode used on the label"
        },
        "Errors": {
          "type": "array",
          "items": {}
        },
        "Warnings": {
          "type": "array",
          "description": "Possible warnings. See the [Error Codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes) for possible values",
          "items": {
            "type": "object",
            "properties": {
              "Code": {
                "type": "string",
                "description": "The warning code"
              },
              "Description": {
                "type": "string",
                "description": "The warning description"
              }
            }
          }
        }
      }
    }
  }
}