EventVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/australia-post/main/json-schema/australia-post-event-vo-schema.json",
  "title": "EventVO",
  "description": "An event originating in a partner's system, which AP is to be informed of.",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/australia-post-endpoints-api-openapi.yml#/components/schemas/EventVO",
  "required": [
    "article",
    "audit",
    "event_date_time",
    "event_originator",
    "event_reason",
    "event_type"
  ],
  "type": "object",
  "properties": {
    "event_type": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "The code indicating which type of event has occurred."
    },
    "event_reason": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "Text describing the event type reason."
    },
    "event_reason_text": {
      "maxLength": 80,
      "minLength": 0,
      "type": "string",
      "description": "Text or comments describing the event reason as entered by user."
    },
    "event_date_time": {
      "type": "string",
      "description": "The timestamp indication when the reason occurred in ISO 8601 Offset from UTC format.",
      "format": "date-time"
    },
    "article": {
      "$ref": "#/$defs/ArticleVO"
    },
    "audit": {
      "$ref": "#/$defs/AuditVO"
    },
    "event_originator": {
      "$ref": "#/$defs/EventOriginatorVO"
    },
    "delivery": {
      "$ref": "#/$defs/DeliveryVO"
    },
    "facility": {
      "$ref": "#/$defs/FacilityVO"
    }
  },
  "$defs": {
    "ArticleVO": {
      "required": [
        "article_id"
      ],
      "type": "object",
      "properties": {
        "article_id": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string",
          "description": "The Article Id."
        },
        "full_barcode": {
          "maxLength": 100,
          "minLength": 0,
          "type": "string",
          "description": "The Full Barcode."
        },
        "external_track_url": {
          "type": "string",
          "description": "External tracking url to allow tracking via 3rd party carrier."
        }
      },
      "description": "Article details."
    },
    "AttachmentVO": {
      "required": [
        "attachment_content",
        "content_type"
      ],
      "type": "object",
      "properties": {
        "attachment_content": {
          "type": "string",
          "description": "A base64 encoded PNG image of the recipients signature. Restricted to 10240 bytes."
        },
        "content_type": {
          "type": "string",
          "description": "The type of image format of the attachment content."
        }
      },
      "description": "Image attachments showing details of a delivery (e.g. for damaged article)."
    },
    "AuditVO": {
      "required": [
        "event_id",
        "event_source_name"
      ],
      "type": "object",
      "properties": {
        "event_source_name": {
          "type": "string",
          "description": "Event Source Name."
        },
        "event_id": {
          "type": "string",
          "description": "Event ID."
        }
      },
      "description": "Audit details."
    },
    "DeliveryVO": {
      "type": "object",
      "properties": {
        "destination_postcode": {
          "maxLength": 4,
          "minLength": 4,
          "pattern": "^\\d{4}$",
          "type": "string",
          "description": "The 4-digit Australian Postcode to where the article has been sent"
        },
        "proof_of_delivery": {
          "$ref": "#/$defs/ProofOfDeliveryVO"
        }
      },
      "description": "Delivery details."
    },
    "EventOriginatorVO": {
      "required": [
        "person",
        "system"
      ],
      "type": "object",
      "properties": {
        "system": {
          "$ref": "#/$defs/SystemVO"
        },
        "person": {
          "$ref": "#/$defs/PersonVO"
        }
      },
      "description": "Details of the System where the event originated."
    },
    "FacilityVO": {
      "type": "object",
      "properties": {
        "location": {
          "$ref": "#/$defs/LocationVO"
        }
      },
      "description": "Facility details"
    },
    "LocationVO": {
      "required": [
        "location_name",
        "work_centre_code"
      ],
      "type": "object",
      "properties": {
        "work_centre_code": {
          "maxLength": 10,
          "minLength": 1,
          "type": "string",
          "description": "Work Centre Code."
        },
        "location_name": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "Location Name."
        }
      },
      "description": "Location details"
    },
    "PersonVO": {
      "required": [
        "person_id"
      ],
      "type": "object",
      "properties": {
        "person_id": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "The identifier of the sending person."
        }
      },
      "description": "The person associated with the origin of the event."
    },
    "ProofOfDeliveryVO": {
      "type": "object",
      "properties": {
        "signer_name": {
          "maxLength": 80,
          "minLength": 1,
          "type": "string",
          "description": "The name of the person signing for acceptance of the delivery."
        },
        "identification_type": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "The type of ID presented."
        },
        "receiver_dob": {
          "type": "string",
          "description": "The date of birth of the recipient (ddMMyyyy).",
          "format": "date-time"
        },
        "attachment": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AttachmentVO"
          }
        },
        "service_actions": {
          "$ref": "#/$defs/ServiceActionsVO"
        }
      },
      "description": "The details of the delivery."
    },
    "ServiceActionsVO": {
      "type": "object",
      "properties": {
        "type_id": {
          "maxLength": 50,
          "minLength": 0,
          "type": "string",
          "description": "The type of ID presented. Valid types are: Australian Driver License,Red or Orange MyPost card with address, Keypass or other Government-issued Proof of Age card, Australian or international passport, Digital iD."
        },
        "id_available": {
          "pattern": "X|N",
          "type": "string",
          "description": "Was ID of the receiver made available at the time of delivery?"
        },
        "sight_id": {
          "pattern": "X|N",
          "type": "string",
          "description": "Was ID of the receiver sighted by the person making the delivery?"
        },
        "over_18": {
          "pattern": "X|N",
          "type": "string",
          "description": "Was the recipient over 18? Relevant where the Service Code on the manifest is one of 81, 82, 83."
        }
      },
      "description": "Elements relating to the specific Product Service Codes, e.g. Service Codes 81, 82 and 83 are for alcohol and require ID to be presented in some Australian States"
    },
    "SystemVO": {
      "required": [
        "sender_id",
        "sender_name"
      ],
      "type": "object",
      "properties": {
        "sender_id": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "The identifier of the sending system."
        },
        "sender_name": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "The name of the sending system."
        }
      },
      "description": "The System where the event originated."
    }
  }
}