Purpose
order_ready_for_submission fires when all required information to submit an order has been successfully received, for affiliates whose settings require manual submission (as opposed to order_submitted, which fires when an order auto-submits).
Field guarantees
| Field | Guarantee |
|---|---|
eventData | Envelope only — intentionally empty |
order_id, order_status in v2 | ✅ Resolved from the target order — status is typically requires_order_submission when this event fires |
v1 payload (legacy)
{
"_id": "event::6b7c8d9e-xxxx-xxxx-xxxx-0f1a2b3c4d5e",
"ownerEntity": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
"ownerEntityModel": "Patient",
"targetEntity": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
"targetEntityModel": "Order",
"eventTitle": "Order Ready For Submission.",
"eventDescription": "All required information to submit the order was successfully received. The affiliate settings require manual submission.",
"eventType": "order_ready_for_submission",
"eventData": {},
"deleted": false,
"createdAt": {
"$date": "2026-01-01T12:00:00.000Z"
},
"updatedAt": {
"$date": "2026-01-01T12:00:00.000Z"
},
"__v": 0
}v2 payload
Sanitized envelope. Order fields are resolved from the target entity.
{
"event_type": "order_ready_for_submission",
"event_id": "event::6b7c8d9e-xxxx-xxxx-xxxx-0f1a2b3c4d5e",
"api_version": "2026-08-09",
"timestamp": "2026-05-30T14:00:00.000Z",
"affiliate_id": "aff::example",
"patient_id": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
"patient_external_id": "ext-patient-123",
"patient_marketing_consent": false,
"is_returning_patient": false,
"order_id": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
"order_status": "requires_order_submission"
}The complete order detail is available via the authenticated GET /orders/:id endpoint.