SHPCResponseVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-shpcresponse-vo-schema.json",
  "title": "SHPCResponseVO",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-close-api-openapi.yml#/components/schemas/SHPCResponseVO",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492"
    },
    "output": {
      "$ref": "#/$defs/EndOfDayCloseOutputVO"
    }
  },
  "$defs": {
    "Alert": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the api alert code.<br>Example: SHIP.RECIPIENT.POSTALCITY.MISMATCH"
        },
        "alertType": {
          "type": "string",
          "description": "Specifies the api alert type.",
          "enum": [
            "NOTE",
            "WARNING"
          ]
        },
        "message": {
          "type": "string",
          "description": "Specifies the api alert message.<br>Example: Recipient Postal-City Mismatch."
        }
      },
      "description": "Specifies the api alerts."
    },
    "CloseDocument": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Specifies the type of report.",
          "enum": [
            "MANIFEST",
            "OP_950"
          ]
        },
        "shippingCycle": {
          "type": "string",
          "description": "Identifies the shipping cycle covered by the content of this document."
        },
        "shippingDocumentDisposition": {
          "type": "string",
          "description": ""
        },
        "accessReference": {
          "type": "string",
          "description": "The name under which a STORED or DEFFERED document is written."
        },
        "resolution": {
          "type": "integer",
          "description": "Specifies the image resolution in dpi(Dots per inch)"
        },
        "copiesToPrint": {
          "type": "integer",
          "description": "Can be zero for documents whose dispositions no content is included."
        },
        "parts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ShippingDocumentPart"
          }
        }
      }
    },
    "EndOfDayCloseOutputVO": {
      "type": "object",
      "properties": {
        "alerts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        },
        "closeDocuments": {
          "type": "array",
          "description": "The actual document contents for all provided reports.",
          "items": {
            "$ref": "#/$defs/CloseDocument"
          }
        }
      }
    },
    "ShippingDocumentPart": {
      "type": "object",
      "properties": {
        "documentPartSequenceNumber": {
          "type": "integer",
          "description": "The one-origin position of this part within a document."
        },
        "image": {
          "type": "string",
          "description": "Graphic or printer commands for this image."
        }
      },
      "description": "One or more document parts which makeup a single logical document"
    }
  }
}