MailingResponseDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/print-one/json-schema/print-one-mailing-response-dto-schema.json",
  "title": "MailingResponseDto",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/print-one-openapi.json#/components/schemas/MailingResponseDto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID for the mailing"
    },
    "templateId": {
      "type": "string",
      "description": "Template ID for the order"
    },
    "finish": {
      "type": "string",
      "enum": [
        "GLOSSY",
        "MATTE"
      ],
      "description": "Finish of the order"
    },
    "format": {
      "type": "string",
      "enum": [
        "POSTCARD_A5",
        "POSTCARD_A6",
        "POSTCARD_SQ15",
        "POSTCARD_MAXI",
        "POSTCARD_DIN_LONG",
        "GREETINGCARD_SQ14",
        "LETTER_A4",
        "SELFMAILER_MAXI"
      ],
      "description": "Format of the Mailing."
    },
    "destination": {
      "type": "string",
      "description": "Destination of the mailing",
      "enum": [
        "NETHERLANDS",
        "GERMANY",
        "INTERNATIONAL"
      ]
    },
    "orderCount": {
      "type": "number",
      "description": "The number of orders in the mailing"
    },
    "costs": {
      "type": "object",
      "description": "Costs of the mailing",
      "additionalProperties": false,
      "properties": {
        "total": {
          "type": "number",
          "description": "Total cost of the mailing"
        },
        "subtotal": {
          "type": "number",
          "description": "Subtotal cost before tax"
        },
        "tax": {
          "type": "number",
          "description": "Tax applied to the mailing"
        }
      }
    },
    "deliveryType": {
      "type": "string",
      "description": "The type of delivery for the mailing"
    },
    "status": {
      "type": "string",
      "description": "The status of the mailing"
    },
    "isSampleMailing": {
      "type": "boolean",
      "description": "Whether this is an sample mailing"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "The date and time when the mailing was created"
    },
    "sendDate": {
      "format": "date-time",
      "type": "string",
      "description": "The date and time when the mailing was send"
    },
    "qrScanCount": {
      "type": "number",
      "description": "Number of items in the mailing whose QR code was scanned"
    }
  },
  "required": [
    "id",
    "templateId",
    "finish",
    "format",
    "destination",
    "orderCount",
    "costs",
    "deliveryType",
    "status",
    "isSampleMailing",
    "createdAt",
    "sendDate"
  ]
}