Skip to content
snapcasterDevelopers

InventoryAdjustedData

Reusable InventoryAdjustedData schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
seller_idrequiredintegerNoneRouting target: the Seller that owns the inbound API key (STABLE).0 (generated)
linesrequiredarray of objectminimum items: 1All of one Order's adjustment lines: one event, one `event_id`, per sale (STABLE).[ { "sku_id": 0, "external_ref": "string", "delta": 0 } ] (generated)
lines[].sku_idrequiredintegerNoneCanonical TCGplayer sku id, the same id the listing push uses (STABLE).0 (generated)
lines[].external_refrequiredstring or nullNoneEcho of the Seller's opaque listing ref, untouched, so the delta applies against the Platform's own product id; null if the Listing carried none (STABLE).string (generated)
lines[].deltarequiredintegerNoneSigned unit adjustment: negative commits units (a sale), positive releases them (a cancellation/refund). Apply idempotently as `on_hand += delta` (STABLE).0 (generated)
reasonstringallowed values: sale, cancellation, refund, correctionWhy the stock moved; attribution only, not required to apply the delta. The enum may gain values, so branch leniently (PROVISIONAL).sale (generated)
order_refstringNoneOpaque Order attribution for support/debugging; a pure POS can ignore it (PROVISIONAL).string (generated)

Examples

Generated Schema example: Generated InventoryAdjustedData
{
"seller_id": 0,
"lines": [
{
"sku_id": 0,
"external_ref": "string",
"delta": 0
}
]
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9