Skip to content
snapcasterDevelopers

OrderWebhookLine

Reusable OrderWebhookLine schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
sku_idrequiredintegerNoneCanonical TCGplayer sku id (STABLE).0 (generated)
product_idrequiredintegerNoneCanonical TCGplayer product id (STABLE).0 (generated)
quantityrequiredintegerNoneThe number of inventory units represented by this record.0 (generated)
unit_pricerequiredintegerNoneInteger minor units (cents) in the order currency (STABLE).0 (generated)
namerequiredstringNoneDescriptive snapshot, frozen at order time (STABLE).string (generated)
setrequiredstringNoneThe card set or expansion.string (generated)
conditionrequiredstringNoneThe normalized condition assigned to the card.string (generated)
external_refrequiredstring or nullNoneEcho of the Seller's opaque listing ref; null if none (STABLE).string (generated)
languagestring or nullNoneThe language of the card printing.string (generated)
finishstring or nullNoneThe physical finish or foil treatment of the card.string (generated)
disclosuresobjectNoneProvenance, grading, and authenticity statements shown to the buyer.{ "image_source": "catalog", "condition_source": "seller_declared", "authenticity_source": "seller_attestation", "snapcaster_inspected": false, "snapcaster_graded": false, "snapcaster_authenticated": false, "grading_standard": "string", "declared_grade": "string", "buyer_protection": "string" } (generated)
disclosures.image_sourcerequiredstringallowed values: catalogWho supplied the product image shown to the buyer.catalog (generated)
disclosures.condition_sourcerequiredstringallowed values: seller_declaredWho assigned the displayed card condition.seller_declared (generated)
disclosures.authenticity_sourcerequiredstringallowed values: seller_attestationWho supplied the authenticity determination.seller_attestation (generated)
disclosures.snapcaster_inspectedrequiredbooleanallowed values: falseWhether Snapcaster physically inspected the card.false (generated)
disclosures.snapcaster_gradedrequiredbooleanallowed values: falseWhether Snapcaster assigned the displayed grade.false (generated)
disclosures.snapcaster_authenticatedrequiredbooleanallowed values: falseWhether Snapcaster authenticated the card.false (generated)
disclosures.grading_standardrequiredstringNoneThe grading standard used for the declared grade.string (generated)
disclosures.declared_graderequiredstring or nullNoneThe grade declared for the card under the named standard.string (generated)
disclosures.buyer_protectionrequiredstringNoneThe buyer-protection coverage attached to this offering.string (generated)
fulfillment_obligationobjectNoneThe exact item characteristics the Seller must fulfill.{ "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } (generated)
fulfillment_obligation.skurequiredstringallowed values: exactThe stock-keeping identity for the exact card offering.exact (generated)
fulfillment_obligation.printingrequiredstringallowed values: exactThe exact card printing the Seller is obligated to supply.exact (generated)
fulfillment_obligation.languagerequiredstringallowed values: exactThe language of the card printing.exact (generated)
fulfillment_obligation.finishrequiredstringallowed values: exactThe physical finish or foil treatment of the card.exact (generated)
fulfillment_obligation.conditionrequiredstringallowed values: declared-or-betterThe normalized condition assigned to the card.declared-or-better (generated)

Examples

Generated Schema example: Generated OrderWebhookLine
{
"sku_id": 0,
"product_id": 0,
"quantity": 0,
"unit_price": 0,
"name": "string",
"set": "string",
"condition": "string",
"external_ref": "string"
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9