snapcasterDevelopers

    API reference · Types

    OrderRefundedData

    Part of the payload of order.refunded.

    Type: object

    Example

    Schema example: from the order.refunded payload
    {
  "order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
  "seller_id": 42,
  "restock": true,
  "lines": [
    {
      "line_ref": "oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241",
      "sku_id": 14602,
      "external_ref": "platform-listing-1042",
      "quantity": 1
    }
  ]
}

    Fields

    order_id string required

    The refunded order id. Use it to reconcile events for the same order (STABLE).

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    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

    restock boolean required

    Whether the seller declared that the physical units came back and can be sold again. Snapcaster does not infer this value. A value of false, for example for lost mail or a wrong card, leaves stock unchanged (STABLE).

    Example true

    lines TerminationLine[] required

    The refunded lines and quantities (STABLE).

    Constraints: minimum items: 1

    Show child fieldsHide child fields
    lines[].line_ref string or null required

    The purchase-line reference of the terminated line, the same line_ref the order body carries. Reconcile on this field: an order can hold two lines of one sku_id, and only this says which of them was cancelled or refunded. Null only on an event Snapcaster froze before this field existed.

    Example oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241

    lines[].sku_id integer required

    Canonical TCGplayer SKU id, the same id as the order line (STABLE).

    Example 14602

    lines[].external_ref string or null required

    Echo of the seller's opaque listing ref; null if the listing carried none (STABLE).

    Example platform-listing-1042

    lines[].quantity integer required

    The cancelled or refunded quantity. It may be less than the quantity ordered for this line (STABLE).

    Example 1

    Used by