Regulatory Document

Sample payloads for regulatory_document.pending, regulatory_document.uploaded and regulatory_document.complete.

These events track regulatory paperwork required for a shipment to clear — an FDA Prior Notice, for example. They carry a small purpose-built object rather than a full resource.

Note that regulatory_document.pending is keyed by request_id (the document request), while the other two are keyed by shipment_id.

regulatory_document.pending

A document is required and has been requested.

{
    "event": "regulatory_document.pending",
    "data": {
        "request_id": "DR-58104772390",
        "document": {
            "type": "FDA",
            "document_id": "DOC-77301948265",
            "status": "pending",
            "document_url": ""
        },
        "source": "document_request_fda_worker"
    }
}

regulatory_document.uploaded

A document has been produced and attached to the shipment.

{
    "event": "regulatory_document.uploaded",
    "data": {
        "shipment_id": "SH-40208776515",
        "document": {
            "type": "FDA",
            "document_id": "DOC-77301948265",
            "status": "uploaded",
            "document_url": "https://assets.terminal.africa/regulatory/DOC-77301948265.pdf"
        }
    }
}

regulatory_document.complete

Every document the shipment needs is now in place.

{
    "event": "regulatory_document.complete",
    "data": {
        "shipment_id": "SH-40208776515",
        "regulatory_documents": [
            {
                "type": "FDA",
                "document_id": "DOC-77301948265",
                "status": "complete",
                "document_url": "https://assets.terminal.africa/regulatory/DOC-77301948265.pdf"
            }
        ],
        "regulatory_documents_status": "complete"
    }
}