Skip to content
snapcasterDevelopers

OrderRefundedData

Reusable OrderRefundedData schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
order_idrequiredstringNoneThe Order this Refund covers: the reconcile key (STABLE).string (generated)
seller_idrequiredintegerNoneRouting target: the Seller that owns the inbound API key (STABLE).0 (generated)
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)
linesrequiredarray of objectminimum items: 1Exactly the lines (and quantities) this Refund covers (STABLE).[ { "sku_id": 0, "external_ref": "string", "quantity": 0 } ] (generated)
lines[].sku_idrequiredintegerNoneCanonical TCGplayer sku id, the same id as the order line (STABLE).0 (generated)
lines[].external_refrequiredstring or nullNoneEcho of the Seller's opaque listing ref; null if the Listing carried none (STABLE).string (generated)
lines[].quantityrequiredintegerNoneThe terminated quantity; may be less than the line’s ordered quantity (STABLE).0 (generated)

Examples

Generated Schema example: Generated OrderRefundedData
{
"order_id": "string",
"seller_id": 0,
"restock": true,
"lines": [
{
"sku_id": 0,
"external_ref": "string",
"quantity": 0
}
]
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9