Skip to content
snapcasterDevelopers

OrderRefundedEvent

Reusable OrderRefundedEvent schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
event_idrequiredstringNoneGlobally unique, stable across retries. Refunds are repeatable: each Refund is its own event with its own id; dedup is per-Refund, not per-Order (STABLE).string (generated)
typerequiredstringallowed values: order.refundedEvent discriminator (STABLE).order.refunded (generated)
created_atrequiredstringNoneISO-8601 UTC instant of the Refund itself (STABLE).string (generated)
datarequiredobjectNoneThe operation or event payload.{ "order_id": "string", "seller_id": 0, "restock": true, "lines": [ { "sku_id": 0, "external_ref": "string", "quantity": 0 } ] } (generated)
data.order_idrequiredstringNoneThe Order this Refund covers: the reconcile key (STABLE).string (generated)
data.seller_idrequiredintegerNoneRouting target: the Seller that owns the inbound API key (STABLE).0 (generated)
data.restockrequiredbooleanNoneThe seller’s explicit declaration that the physical units came back and are sellable again, never inferred. `false` (lost mail, wrong card sent) moves no stock anywhere (STABLE).true (generated)
data.linesrequiredarray of objectminimum items: 1Exactly the lines (and quantities) this Refund covers (STABLE).[ { "sku_id": 0, "external_ref": "string", "quantity": 0 } ] (generated)
data.lines[].sku_idrequiredintegerNoneCanonical TCGplayer sku id, the same id as the order line (STABLE).0 (generated)
data.lines[].external_refrequiredstring or nullNoneEcho of the Seller's opaque listing ref; null if the Listing carried none (STABLE).string (generated)
data.lines[].quantityrequiredintegerNoneThe terminated quantity; may be less than the line’s ordered quantity (STABLE).0 (generated)
api_versionrequiredstringallowed values: 2026-07The dated partner API version this payload was serialized at: the version frozen when the delivery was enqueued (never the live pin), so every retry carries the same value and byte-identical bytes. Added additively per the tolerant-reader rule; see https://developers.snapcaster.ca/guide/api-versioning (STABLE).2026-07 (generated)

Examples

Generated Schema example: Generated OrderRefundedEvent
{
"event_id": "string",
"type": "order.refunded",
"created_at": "string",
"data": {
"order_id": "string",
"seller_id": 0,
"restock": true,
"lines": [
{
"sku_id": 0,
"external_ref": "string",
"quantity": 0
}
]
},
"api_version": "2026-07"
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9