snapcasterDevelopers

    API reference · Types

    OrderWebhookLine

    Part of the response of 7 operations and the payload of order.created and order.updated.

    Type: object

    Example

    Schema example: from the order.created payload
    {
  "line_ref": "oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241",
  "sku_id": 14602,
  "product_id": 86,
  "quantity": 1,
  "unit_price": 2499,
  "name": "Abyssal Nightstalker",
  "set": "Portal Second Age",
  "condition": "NM",
  "external_ref": "platform-listing-1042",
  "collector_number": null,
  "language": "English",
  "finish": "Non-Foil"
}

    Fields

    line_ref string required

    The purchase-line reference, for example oln_1f0c…. It identifies WHICH PURCHASE this line is, where sku_id identifies which card. One order can hold two lines of the same sku_id bought at different times and prices, so key your fulfillment records on this field. It is also what you send back in lines[].lineRef when you cancel or refund a line.

    Example oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241

    sku_id integer required

    Canonical TCGplayer SKU id (STABLE).

    Example 14602

    product_id integer required

    Canonical TCGplayer product id (STABLE).

    Example 86

    quantity integer required

    The number of units.

    Example 1

    unit_price integer required

    Integer minor units (cents) in the order currency (STABLE).

    Example 2499

    name string or null required

    Descriptive snapshot, frozen at order time (STABLE).

    Example Abyssal Nightstalker

    set string or null required

    The card set or expansion.

    Example Portal Second Age

    condition string or null required

    The normalized condition assigned to the card.

    Example NM

    external_ref string or null required

    The seller's listing reference, returned unchanged; null if none was supplied (STABLE).

    Example platform-listing-1042

    collector_number string or null required

    The card's catalog collector number, saved when the order was created, for example 161/302. Null if the catalog had no number or the order predates this field. An additive field on the STABLE line.

    Example null

    language string or null

    The language of the card printing.

    Example English

    finish string or null

    The physical finish or foil treatment of the card.

    Example Non-Foil

    disclosures object

    Provenance, grading, and authenticity statements shown to the buyer.

    Show child fieldsHide child fields
    disclosures.image_source string required

    Who supplied the product image shown to the buyer.

    Constraints: allowed values: catalog

    disclosures.condition_source string required

    Who assigned the displayed card condition.

    Constraints: allowed values: seller_declared

    disclosures.authenticity_source string required

    Who supplied the authenticity determination.

    Constraints: allowed values: seller_attestation

    disclosures.snapcaster_inspected boolean required

    Whether Snapcaster physically inspected the card.

    Constraints: allowed values: false

    disclosures.snapcaster_graded boolean required

    Whether Snapcaster assigned the displayed grade.

    Constraints: allowed values: false

    disclosures.snapcaster_authenticated boolean required

    Whether Snapcaster authenticated the card.

    Constraints: allowed values: false

    disclosures.grading_standard string required

    The grading standard used for the declared grade.

    disclosures.declared_grade string or null required

    The grade declared for the card under the named standard.

    disclosures.buyer_protection string required

    The buyer-protection coverage attached to this offering.

    fulfillment_obligation object

    The exact item characteristics the seller must fulfill.

    Show child fieldsHide child fields
    fulfillment_obligation.sku string required

    The SKU that identifies the card variant.

    Constraints: allowed values: exact

    fulfillment_obligation.printing string required

    The card printing the seller must supply.

    Constraints: allowed values: exact

    fulfillment_obligation.language string required

    The language of the card printing.

    Constraints: allowed values: exact

    fulfillment_obligation.finish string required

    The physical finish or foil treatment of the card.

    Constraints: allowed values: exact

    fulfillment_obligation.condition string required

    The normalized condition assigned to the card.

    Constraints: allowed values: declared-or-better

    Used by