snapcasterDevelopers

    API reference · Types

    OrderAdditionRequestEventData

    Part of the payload of order.addition_request.created and order.addition_request.resolved.

    Type: object

    Example

    Schema example: from the order.addition_request.created payload
    {
  "request_ref": "oar_5c1e9a7f3b2d48e6a0f4c8d1b7e3a925",
  "status": "pending",
  "lines": [
    {
      "sku_id": 14602,
      "product_id": 86,
      "quantity": 2,
      "name": "Abyssal Nightstalker",
      "set_name": "Portal Second Age",
      "condition": "Near Mint",
      "category_name": "Magic: The Gathering",
      "language": "English",
      "finish": "Normal",
      "collector_number": null,
      "rarity": "Uncommon"
    }
  ],
  "note": "Two more for my sideboard, please",
  "support_case_id": null,
  "created_at": "2026-09-04T19:01:12.000Z",
  "resolved_by_party": null,
  "resolved_at": null,
  "resolution_note": null,
  "order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
  "seller_id": 42
}

    Fields

    request_ref string required

    The opaque public request id (oar_…) - the {requestRef} of the withdraw and decline paths.

    Example oar_5c1e9a7f3b2d48e6a0f4c8d1b7e3a925

    status string required

    pending is the one open state. withdrawn is the buyer taking their own ask back; declined is the seller’s answer; offered means the seller ANSWERED it with a payable offer, whose own lifecycle carries on under addition-offers and which names this request. All three endings are one-way and change nothing else about the order.

    Constraints: allowed values: pending, withdrawn, declined, offered Example pending

    lines OrderAdditionRequestLine[] required

    The cards asked for, with enough canonical catalog identity frozen at the ask to say which PRINTING was meant - condition, finish, language, collector number - so a later catalog correction cannot change what was understood.

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

    The exact printing asked for. This is the identity; everything beside it is frozen from it.

    Example 14602

    lines[].product_id integer required

    See Canonical catalog in Core concepts.

    Example 86

    lines[].quantity integer required

    The number of units.

    Example 2

    lines[].name string or null required

    Example Abyssal Nightstalker

    lines[].set_name string or null required

    Example Portal Second Age

    lines[].condition string or null required

    The normalized condition assigned to the card.

    Example Near Mint

    lines[].category_name string or null required

    Example Magic: The Gathering

    lines[].language string or null required

    The language of the card printing.

    Example English

    lines[].finish string or null required

    The catalog’s printing, under the name the order line snapshot uses.

    Example Normal

    lines[].collector_number string or null required

    Example null

    lines[].rarity string or null required

    The rarity assigned to the card printing.

    Example Uncommon

    note string or null required

    The buyer’s own words beside the ask; null when none was given.

    Example Two more for my sideboard, please

    support_case_id integer or null required

    The support conversation the ask came out of, when there was one; null otherwise.

    Example null

    created_at string required

    Example 2026-09-04T19:01:12.000Z

    resolved_by_party string or null required

    Who ended the ask - buyer on a withdrawal, seller on a decline. Null while pending.

    Constraints: allowed values: buyer, seller, operator, system, null Example null

    resolved_at string or null required

    Example null

    resolution_note string or null required

    The seller’s short reason on a decline, shown to the buyer beside the ending.

    Example null

    order_id string required

    The order the add-on is for (STABLE).

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    seller_id integer required

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

    Example 42

    Used by