Package was delivered

Purpose

shipment_delivered fires when a package has been successfully delivered to the patient's address.

Payload shape (v2)

{
  "event_type": "shipment_delivered",
  "event_id": "event::8f1a2b3c-4d5e-4f6a-8b7c-9d1e2f3a4b5c",
  "api_version": "2026-08-09",
  "timestamp": "2026-07-15T15:00:00.000Z",
  "affiliate_id": "aff::example",
  "patient_id": "pat::43e3b917-8d95-4745-942d-70679b4a1b3f",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": true,
  "is_returning_patient": false,
  "order_id": "ord::example",
  "prescription_id": "rx::example",
  "shipment_status": "delivered",
  "commerce_status": "processing",
  "tracking_number": "1Z999AA10123456784",
  "tracking_url": "https://www.ups.com/track?loc=en_US&tracknum=1Z999AA10123456784",
  "shipping_carrier": "UPS"
}

This event carries the shipment and tracking details; complete fulfillment status is available via the authenticated GET /prescriptions/:id endpoint.