Ecommerce Order Refunded

Fires when an ecommerce order refund is processed. The eventType is ecommerce_order_refunded. Categories: COMMERCE, PAYMENT.

šŸ“˜

v1 and v2 payloads are identical for commerce events. These are commerce-native events built on the flat, sanitized payload shape.

Field guarantees

FieldGuarantee
ecommerce_order_id, commerce_status, total_value_cents, currency, refund_amount_cents, refund_typeāœ… Always present
payment_statusāš ļø Conditional

Payload (v1 and v2)

{
  "event_type": "ecommerce_order_refunded",
  "api_version": "2026-08-09",
  "timestamp": "2026-05-26T12:00:00.000Z",
  "affiliate_id": "aff::example",
  "patient_id": "pat::example",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": true,
  "is_returning_patient": false,
  "ecommerce_order_id": "eord::example",
  "commerce_status": "refunded",
  "total_value_cents": 4999,
  "currency": "usd",
  "payment_status": "refunded",
  "refund_amount_cents": 4999,
  "refund_type": "full"
}
FieldTypeAlways?Notes
ecommerce_order_id, commerce_statusstringāœ…
total_value_cents, currencynumber/stringāœ…
refund_amount_centsnumberāœ…Amount refunded
refund_typestringāœ…e.g. full, partial
payment_statusstringāš ļøe.g. refunded