snapcasterDevelopers

    API reference · Types

    InventoryAdjustedData

    Part of the payload of inventory.adjusted.

    Type: object

    Example

    Schema example: from the inventory.adjusted payload
    {
  "seller_id": 42,
  "lines": [
    {
      "sku_id": 14602,
      "external_ref": "platform-listing-1042",
      "delta": -1
    }
  ],
  "reason": "sale",
  "order_ref": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW"
}

    Fields

    seller_id integer required

    The seller that owns the API key. Use this id to route the event to the right store (STABLE).

    Example 42

    lines InventoryAdjustedLine[] required

    The adjustment lines for one order. Each sale has one event and one event_id (STABLE).

    Constraints: minimum items: 1

    Show child fieldsHide child fields
    lines[].sku_id integer required

    Canonical TCGplayer SKU id, the same id the listing push uses (STABLE).

    Example 14602

    lines[].external_ref string or null required

    The seller's listing reference, returned unchanged so you can match the adjustment to your own record. Null if none was supplied (STABLE).

    Example platform-listing-1042

    lines[].delta integer required

    The stock adjustment in units. A negative value deducts a sale; a positive value restores a cancellation or restocked refund. Deduplicate the event, then apply on_hand += delta (STABLE).

    Example -1

    reason string

    Why stock changed. You can apply the delta without using this field. Handle unknown values because the enum may expand (PROVISIONAL).

    Constraints: allowed values: sale, cancellation, refund, correction Example sale

    order_ref string

    An order reference for support and debugging. A POS that only manages inventory can ignore it (PROVISIONAL).

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    Used by