SummarySuccessResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-summary-success-response-schema.json",
  "title": "SummarySuccessResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-informed-delivery-mail-campaigns-openapi.yml#/components/schemas/SummarySuccessResponse",
  "type": "object",
  "properties": {
    "campaignID": {
      "type": "string",
      "description": "Unique identifier for the campaign."
    },
    "totalBarcodes": {
      "type": "number",
      "description": "The total number of barcodes in the callback key transaction."
    },
    "totalBarcodesAdded": {
      "type": "number",
      "description": "The total number of barcodes successfully added to the campaign via the callback key transaction."
    },
    "totalBarcodesFailed": {
      "type": "number",
      "description": "The total number of barcodes that failed to be added to the campaign via the callback key transaction."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string",
            "description": "Details of the error."
          },
          "quantity": {
            "type": "number",
            "description": "Quantity of items affected by the error."
          }
        }
      }
    }
  }
}