Skip to content
snapcasterDevelopers

BrowseProductOffersResponse

Reusable BrowseProductOffersResponse schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
successrequiredbooleanallowed values: trueWhether the operation completed as requested.true (generated)
degradedbooleanallowed values: truePresent and true while the marketplace is in Degraded Mode: prices and availability on browse surfaces may be briefly out of date, and are confirmed before purchase. Absent when the platform is healthy.true (generated)
datarequiredobjectNoneThe operation or event payload.{ "offers": [ { "lane": "native", "productId": 0, "sellerId": 0, "storeSlug": "string", "variantId": 0, "skuId": 0, "sellerName": "string", "condition": "string", "language": "string", "finish": "string", "isSealed": true, "price": 0, "available": 0, "checkoutMode": "express", "salesCount": 0, "sellerCode": "string", "reviewScore": { "score": 0, "count": 0 }, "poBoxDelivery": { "status": "available" }, "disclosures": { "imageSource": "catalog", "conditionSource": "seller_declared", "authenticitySource": "seller_attestation", "snapcasterInspected": false, "snapcasterGraded": false, "snapcasterAuthenticated": false, "gradingStandard": "snapcaster-magic-v1", "declaredGrade": "string", "buyerProtection": "magic-grade-and-authenticity" }, "fulfillmentObligation": { "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } } ], "product": { "productId": 0, "name": "string", "set": "string", "rarity": "string", "collectorNumber": "string", "imageUrl": "string", "details": [ { "label": "string", "value": "string" } ] } } (generated)
data.offersrequiredarray of objectNoneThe Product’s offers, cheapest first.[ { "lane": "native", "productId": 0, "sellerId": 0, "storeSlug": "string", "variantId": 0, "skuId": 0, "sellerName": "string", "condition": "string", "language": "string", "finish": "string", "isSealed": true, "price": 0, "available": 0, "checkoutMode": "express", "salesCount": 0, "sellerCode": "string", "reviewScore": { "score": 0, "count": 0 }, "poBoxDelivery": { "status": "available" }, "disclosures": { "imageSource": "catalog", "conditionSource": "seller_declared", "authenticitySource": "seller_attestation", "snapcasterInspected": false, "snapcasterGraded": false, "snapcasterAuthenticated": false, "gradingStandard": "snapcaster-magic-v1", "declaredGrade": "string", "buyerProtection": "magic-grade-and-authenticity" }, "fulfillmentObligation": { "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } } ] (generated)
data.offers[].lanerequiredstringallowed values: native, handoffWhich lane this offer comes from (#1634, ADR-0068): `native` is a marketplace Seller’s Listing, `handoff` is a Handoff Store’s synced single. Read this first - it says which identity fields carry a value and whether Snapcaster stands behind the sale at all.native (generated)
data.offers[].productIdrequiredintegerNoneProduct Id for the surrounding offers item record.0 (generated)
data.offers[].sellerIdrequiredinteger or nullNoneCart-line key (with `skuId`); identifies the offering Seller. `null` on a `handoff` offer: a Handoff Store has no seller record and never gets a synthetic one.0 (generated)
data.offers[].storeSlugrequiredstring or nullNoneThe Handoff Store’s slug - its stable identity across the cart, the quote and the permalink. `null` on a `native` offer.string (generated)
data.offers[].variantIdrequiredinteger or nullNoneThe Shopify variant this handoff offer is for; with `storeSlug` it is the handoff cart-line key. `null` on a `native` offer.0 (generated)
data.offers[].skuIdrequiredintegerNoneThe canonical TCGplayer sku id. With `sellerId` it is the NATIVE cart-line key; a `handoff` offer has no `sellerId` and is carted by `storeSlug` + `variantId` instead.0 (generated)
data.offers[].sellerNamerequiredstring or nullNoneDisplay name of whoever is offering the card - the Seller’s store name, or the Handoff Store’s name. Not a handle/slug/seller_code.string (generated)
data.offers[].conditionrequiredstring or nullNoneThe normalized condition assigned to the card.string (generated)
data.offers[].languagerequiredstring or nullNoneThe language of the card printing.string (generated)
data.offers[].finishrequiredstring or nullNoneThe physical finish or foil treatment of the card.string (generated)
data.offers[].isSealedrequiredbooleanNoneTrue when the canonical SKU condition is `Unopened`; matches the Product grid classification.true (generated)
data.offers[].pricerequiredintegerNoneOffer price in integer minor units (cents).0 (generated)
data.offers[].availablerequiredintegerNoneAvailable stock: on-hand minus committed units.0 (generated)
data.offers[].checkoutModerequiredstring or nullallowed values: express, manual, nullThe store's buyer-facing checkout mode (ADR-0025): `express` (native — transacts on Snapcaster) or `manual` (handoff — the Buyer finishes on the Seller's own checkout). `null` only for a legacy doc indexed before the field existed.express (generated)
data.offers[].salesCountrequiredinteger or nullNoneThe store's live number of sales (paid-order count), computed live per request — not indexed. A number for an `express` (native) store (`0` for a genuinely-new one); `null` for a `manual` (handoff) store, which mints no orders, so the client renders nothing.0 (generated)
data.offers[].sellerCoderequiredstring or nullNoneThe store’s PUBLIC handle — the Seller-page identity to link this offer to (`/marketplace/sellers/{sellerCode}`). Resolved live from the database, not the search projection; `null` when the store has no directory row (the offer is still served).string (generated)
data.offers[].reviewScorerequiredobjectNoneA store’s live Review score and the count it is drawn from, always together so a low-sample score reads as low-sample. Computed per request and never indexed. A store with no reviews carries `{ score: null, count: 0 }` — never a 0.0 — and a `manual` (handoff) store, unreviewable in v1, reads the same way. Shared by the Seller page and the Product-page offers.{ "score": 0, "count": 0 } (generated)
data.offers[].reviewScore.scorerequirednumber or nullNoneMean of current non-hidden ratings, rounded to 2 decimals. `null` — NOT 0 — when the store has no reviews yet, so a new store is never shown as a 0.0-rated one.0 (generated)
data.offers[].reviewScore.countrequiredintegerNoneHow many current non-hidden Reviews the mean is drawn from.0 (generated)
data.offers[].poBoxDeliveryrequiredobject or nullNoneThe store’s effective PO Box delivery value. `null` on a `handoff` offer: Snapcaster arranges no shipment on that lane, so it makes no claim either way.{ "status": "available" } (generated)
data.offers[].poBoxDelivery.statusrequiredstringallowed values: available, seller_declines, platform_suspended`available`: the store delivers to PO Boxes. `seller_declines`: the store does not. `platform_suspended`: PO Box delivery is suspended platform-wide (e.g. a Canada Post strike) and outranks the store’s own setting.available (generated)
data.offers[].disclosuresrequiredobject or nullNoneProvenance, grading, and authenticity statements shown to the buyer.{ "imageSource": "catalog", "conditionSource": "seller_declared", "authenticitySource": "seller_attestation", "snapcasterInspected": false, "snapcasterGraded": false, "snapcasterAuthenticated": false, "gradingStandard": "snapcaster-magic-v1", "declaredGrade": "string", "buyerProtection": "magic-grade-and-authenticity" } (generated)
data.offers[].disclosures.imageSourcerequiredstringallowed values: catalogImage Source for the surrounding disclosures record.catalog (generated)
data.offers[].disclosures.conditionSourcerequiredstringallowed values: seller_declaredCondition Source for the surrounding disclosures record.seller_declared (generated)
data.offers[].disclosures.authenticitySourcerequiredstringallowed values: seller_attestationAuthenticity Source for the surrounding disclosures record.seller_attestation (generated)
data.offers[].disclosures.snapcasterInspectedrequiredbooleanallowed values: falseSnapcaster Inspected for the surrounding disclosures record.false (generated)
data.offers[].disclosures.snapcasterGradedrequiredbooleanallowed values: falseSnapcaster Graded for the surrounding disclosures record.false (generated)
data.offers[].disclosures.snapcasterAuthenticatedrequiredbooleanallowed values: falseSnapcaster Authenticated for the surrounding disclosures record.false (generated)
data.offers[].disclosures.gradingStandardrequiredstringallowed values: snapcaster-magic-v1, seller-declared-no-specialist-promiseGrading Standard for the surrounding disclosures record.snapcaster-magic-v1 (generated)
data.offers[].disclosures.declaredGraderequiredstring or nullNoneDeclared Grade for the surrounding disclosures record.string (generated)
data.offers[].disclosures.buyerProtectionrequiredstringallowed values: magic-grade-and-authenticity, genuine-and-as-describedBuyer Protection for the surrounding disclosures record.magic-grade-and-authenticity (generated)
data.offers[].fulfillmentObligationrequiredobject or nullNoneFulfillment Obligation for the surrounding offers item record.{ "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } (generated)
data.offers[].fulfillmentObligation.skurequiredstringallowed values: exactThe stock-keeping identity for the exact card offering.exact (generated)
data.offers[].fulfillmentObligation.printingrequiredstringallowed values: exactThe exact card printing the Seller is obligated to supply.exact (generated)
data.offers[].fulfillmentObligation.languagerequiredstringallowed values: exactThe language of the card printing.exact (generated)
data.offers[].fulfillmentObligation.finishrequiredstringallowed values: exactThe physical finish or foil treatment of the card.exact (generated)
data.offers[].fulfillmentObligation.conditionrequiredstringallowed values: declared-or-betterThe normalized condition assigned to the card.declared-or-better (generated)
data.productrequiredobject or nullNoneCard metadata; null when no catalog row exists.{ "productId": 0, "name": "string", "set": "string", "rarity": "string", "collectorNumber": "string", "imageUrl": "string", "details": [ { "label": "string", "value": "string" } ] } (generated)
data.product.productIdrequiredintegerNoneProduct Id for the surrounding product record.0 (generated)
data.product.namerequiredstring or nullNoneThe human-readable name of the resource.string (generated)
data.product.setrequiredstring or nullNoneThe joined group / set name.string (generated)
data.product.rarityrequiredstring or nullNoneDerived from the extended_data `Rarity` entry.string (generated)
data.product.collectorNumberrequiredstring or nullNoneDerived from the extended_data `Number` entry.string (generated)
data.product.imageUrlrequiredstring or nullNoneReal card art from the catalog product.string (generated)
data.product.detailsrequiredarray of objectNoneGeneric surfacing of every extended_data entry as { label, value }.[ { "label": "string", "value": "string" } ] (generated)
data.product.details[].labelrequiredstringNoneThe entry’s displayName, falling back to its machine name.string (generated)
data.product.details[].valuerequiredstringNoneThe value represented by this entry.string (generated)

Examples

Generated Schema example: Generated BrowseProductOffersResponse
{
"success": true,
"data": {
"offers": [
{
"lane": "native",
"productId": 0,
"sellerId": 0,
"storeSlug": "string",
"variantId": 0,
"skuId": 0,
"sellerName": "string",
"condition": "string",
"language": "string",
"finish": "string",
"isSealed": true,
"price": 0,
"available": 0,
"checkoutMode": "express",
"salesCount": 0,
"sellerCode": "string",
"reviewScore": {
"score": 0,
"count": 0
},
"poBoxDelivery": {
"status": "available"
},
"disclosures": {
"imageSource": "catalog",
"conditionSource": "seller_declared",
"authenticitySource": "seller_attestation",
"snapcasterInspected": false,
"snapcasterGraded": false,
"snapcasterAuthenticated": false,
"gradingStandard": "snapcaster-magic-v1",
"declaredGrade": "string",
"buyerProtection": "magic-grade-and-authenticity"
},
"fulfillmentObligation": {
"sku": "exact",
"printing": "exact",
"language": "exact",
"finish": "exact",
"condition": "declared-or-better"
}
}
],
"product": {
"productId": 0,
"name": "string",
"set": "string",
"rarity": "string",
"collectorNumber": "string",
"imageUrl": "string",
"details": [
{
"label": "string",
"value": "string"
}
]
}
}
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9