OrderPollPageResponse

Reusable OrderPollPageResponse schema.

Type: object

Fields

Field	Type	Constraints	Meaning	Example
successrequired	boolean	allowed values: true	Whether the operation completed as requested.	true (generated)
datarequired	object	None	The operation or event payload.	{ "items": [ { "order_id": "string", "seller_id": 0, "created_at": "string", "currency": "string", "customer": { "name": "string", "email": "string", "shipping_address": { "line1": "string", "line2": "string", "city": "string", "province": "string", "postal_code": "string", "country": "string" } }, "lines": [ { "sku_id": 0, "product_id": 0, "quantity": 0, "unit_price": 0, "name": "string", "set": "string", "condition": "string", "external_ref": "string" } ] } ], "nextCursor": "string" } (generated)
data.itemsrequired	array of object	None	Order bodies, each byte-identical to a webhook `order.created` `data`.	[ { "order_id": "string", "seller_id": 0, "created_at": "string", "currency": "string", "customer": { "name": "string", "email": "string", "shipping_address": { "line1": "string", "line2": "string", "city": "string", "province": "string", "postal_code": "string", "country": "string" } }, "lines": [ { "sku_id": 0, "product_id": 0, "quantity": 0, "unit_price": 0, "name": "string", "set": "string", "condition": "string", "external_ref": "string" } ] } ] (generated)
data.items[].order_idrequired	string	None	Snapcaster order id; stable per Seller-order, the reconcile key (STABLE).	string (generated)
data.items[].seller_idrequired	integer	None	Routing target: the Seller that owns the inbound API key (STABLE).	0 (generated)
data.items[].created_atrequired	string	None	ISO-8601 UTC instant the order was created (STABLE).	string (generated)
data.items[].currencyrequired	string	None	ISO 4217 currency code, e.g. CAD (STABLE).	string (generated)
data.items[].customerrequired	object	None	The buyer identity and delivery snapshot frozen for the Order.	{ "name": "string", "email": "string", "shipping_address": { "line1": "string", "line2": "string", "city": "string", "province": "string", "postal_code": "string", "country": "string" } } (generated)
data.items[].customer.namerequired	string	None	The human-readable name of the resource.	string (generated)
data.items[].customer.emailrequired	string	None	The contact email for the person represented by this record.	string (generated)
data.items[].customer.shipping_addressrequired	object	None	The delivery address snapshot frozen for the Order.	{ "line1": "string", "line2": "string", "city": "string", "province": "string", "postal_code": "string", "country": "string" } (generated)
data.items[].customer.shipping_address.line1required	string	None	The primary street-address line.	string (generated)
data.items[].customer.shipping_address.line2required	string or null	None	The optional unit, suite, or secondary address line.	string (generated)
data.items[].customer.shipping_address.cityrequired	string	None	The municipality in the delivery address.	string (generated)
data.items[].customer.shipping_address.provincerequired	string	None	The Canadian province or territory in the delivery address.	string (generated)
data.items[].customer.shipping_address.postal_coderequired	string	None	The Canadian postal code in the delivery address.	string (generated)
data.items[].customer.shipping_address.countryrequired	string	None	ISO 3166-1 alpha-2 country code.	string (generated)
data.items[].linesrequired	array of object	minimum items: 1	One or more line snapshots (STABLE).	[ { "sku_id": 0, "product_id": 0, "quantity": 0, "unit_price": 0, "name": "string", "set": "string", "condition": "string", "external_ref": "string" } ] (generated)
data.items[].lines[].sku_idrequired	integer	None	Canonical TCGplayer sku id (STABLE).	0 (generated)
data.items[].lines[].product_idrequired	integer	None	Canonical TCGplayer product id (STABLE).	0 (generated)
data.items[].lines[].quantityrequired	integer	None	The number of inventory units represented by this record.	0 (generated)
data.items[].lines[].unit_pricerequired	integer	None	Integer minor units (cents) in the order currency (STABLE).	0 (generated)
data.items[].lines[].namerequired	string	None	Descriptive snapshot, frozen at order time (STABLE).	string (generated)
data.items[].lines[].setrequired	string	None	The card set or expansion.	string (generated)
data.items[].lines[].conditionrequired	string	None	The normalized condition assigned to the card.	string (generated)
data.items[].lines[].external_refrequired	string or null	None	Echo of the Seller's opaque listing ref; null if none (STABLE).	string (generated)
data.items[].lines[].language	string or null	None	The language of the card printing.	string (generated)
data.items[].lines[].finish	string or null	None	The physical finish or foil treatment of the card.	string (generated)
data.items[].lines[].disclosures	object	None	Provenance, 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)
data.items[].lines[].disclosures.image_sourcerequired	string	allowed values: catalog	Who supplied the product image shown to the buyer.	catalog (generated)
data.items[].lines[].disclosures.condition_sourcerequired	string	allowed values: seller_declared	Who assigned the displayed card condition.	seller_declared (generated)
data.items[].lines[].disclosures.authenticity_sourcerequired	string	allowed values: seller_attestation	Who supplied the authenticity determination.	seller_attestation (generated)
data.items[].lines[].disclosures.snapcaster_inspectedrequired	boolean	allowed values: false	Whether Snapcaster physically inspected the card.	false (generated)
data.items[].lines[].disclosures.snapcaster_gradedrequired	boolean	allowed values: false	Whether Snapcaster assigned the displayed grade.	false (generated)
data.items[].lines[].disclosures.snapcaster_authenticatedrequired	boolean	allowed values: false	Whether Snapcaster authenticated the card.	false (generated)
data.items[].lines[].disclosures.grading_standardrequired	string	None	The grading standard used for the declared grade.	string (generated)
data.items[].lines[].disclosures.declared_graderequired	string or null	None	The grade declared for the card under the named standard.	string (generated)
data.items[].lines[].disclosures.buyer_protectionrequired	string	None	The buyer-protection coverage attached to this offering.	string (generated)
data.items[].lines[].fulfillment_obligation	object	None	The exact item characteristics the Seller must fulfill.	{ "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } (generated)
data.items[].lines[].fulfillment_obligation.skurequired	string	allowed values: exact	The stock-keeping identity for the exact card offering.	exact (generated)
data.items[].lines[].fulfillment_obligation.printingrequired	string	allowed values: exact	The exact card printing the Seller is obligated to supply.	exact (generated)
data.items[].lines[].fulfillment_obligation.languagerequired	string	allowed values: exact	The language of the card printing.	exact (generated)
data.items[].lines[].fulfillment_obligation.finishrequired	string	allowed values: exact	The physical finish or foil treatment of the card.	exact (generated)
data.items[].lines[].fulfillment_obligation.conditionrequired	string	allowed values: declared-or-better	The normalized condition assigned to the card.	declared-or-better (generated)
data.items[].totals	object	None	Order-level money rollup, integer minor units (cents) in the order currency: `grand_total = subtotal + shipping + tax`. When present, carries all four sums (STABLE).	{ "subtotal": 0, "shipping": 0, "tax": 0, "grand_total": 0 } (generated)
data.items[].totals.subtotalrequired	integer	None	The line-item total before shipping and tax, in minor currency units.	0 (generated)
data.items[].totals.shippingrequired	integer	None	The shipping charge or delivery details for the Order.	0 (generated)
data.items[].totals.taxrequired	integer	None	The tax total or breakdown applied to the Order.	0 (generated)
data.items[].totals.grand_totalrequired	integer	None	The complete Order total including shipping and tax, in minor currency units.	0 (generated)
data.items[].tax	object	None	Tax breakdown: one `{label, rate, amount}` line per applied tax. The whole block is absent exactly when there is no tax (absent if and only if `totals.tax` = 0) (STABLE).	{ "lines": [ { "label": "string", "rate": 0, "amount": 0 } ] } (generated)
data.items[].tax.linesrequired	array of object	None	The individual records carried by this request, response, or event.	[ { "label": "string", "rate": 0, "amount": 0 } ] (generated)
data.items[].tax.lines[].labelrequired	string	None	The human-readable label for this entry.	string (generated)
data.items[].tax.lines[].raterequired	number	None	The decimal tax rate applied to the taxable amount.	0 (generated)
data.items[].tax.lines[].amountrequired	integer	None	The monetary amount in minor currency units.	0 (generated)
data.items[].shipping	object	None	Chosen shipping option: `method` is a plain free-text string (not an enum) and `cost` is integer minor units (cents), mirroring `totals.shipping` (STABLE).	{ "method": "string", "cost": 0 } (generated)
data.items[].shipping.methodrequired	string	None	The method used to carry out the surrounding action.	string (generated)
data.items[].shipping.costrequired	integer	None	The shipping cost in minor currency units.	0 (generated)
data.items[].buyer_notes	string	None	Optional free-text buyer note; absent when the buyer left none (STABLE).	string (generated)
data.items[].status	string	allowed values: accepted, shipped, delivered, cancelled, refunded	The Lifecycle state. Absent until the Order first transitions: an absent status means `created`, and an `order.created` delivery never carries it (STABLE).	accepted (generated)
data.items[].fulfillment	object	None	Tracking block; present once Tracking has been attached at fulfillment (STABLE).	{ "tracking_company": "string", "tracking_number": "string", "tracking_url": "string" } (generated)
data.items[].fulfillment.tracking_companyrequired	string	None	Carrier/company name, as the fulfiller entered it (STABLE).	string (generated)
data.items[].fulfillment.tracking_numberrequired	string	None	Carrier tracking number (STABLE).	string (generated)
data.items[].fulfillment.tracking_urlrequired	string or null	None	Tracking link; null if the fulfiller supplied none (STABLE).	string (generated)
data.nextCursorrequired	string or null	None	Opaque cursor for the next page; null on the last page.	string (generated)

Examples

Generated Schema example: Generated OrderPollPageResponse

{
  "success": true,
  "data": {
    "items": [
      {
        "order_id": "string",
        "seller_id": 0,
        "created_at": "string",
        "currency": "string",
        "customer": {
          "name": "string",
          "email": "string",
          "shipping_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "province": "string",
            "postal_code": "string",
            "country": "string"
          }
        },
        "lines": [
          {
            "sku_id": 0,
            "product_id": 0,
            "quantity": 0,
            "unit_price": 0,
            "name": "string",
            "set": "string",
            "condition": "string",
            "external_ref": "string"
          }
        ]
      }
    ],
    "nextCursor": "string"
  }
}