Skip to content
snapcasterDevelopers

BrowseSearchResponse

Reusable BrowseSearchResponse 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.{ "items": [ { "productId": 0, "name": "string", "set": "string", "category": "string", "rarity": "string", "collectorNumber": "string", "imageUrl": "string", "isSealed": true, "fromPrice": 0, "sellerCount": 0, "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" } } ], "facets": { "category": [ { "value": "string", "count": 0 } ], "set": [ { "value": "string", "count": 0 } ], "rarity": [ { "value": "string", "count": 0 } ], "seller": [ { "sellerCode": "string", "storeName": "string", "count": 0 } ], "condition": [ { "value": "string", "count": 0 } ], "language": [ { "value": "string", "count": 0 } ], "finish": [ { "value": "string", "count": 0 } ], "collectorNumber": [ { "value": "string", "count": 0 } ] }, "nextCursor": "string" } (generated)
data.itemsrequiredarray of objectNoneThe records included in this page or batch.[ { "productId": 0, "name": "string", "set": "string", "category": "string", "rarity": "string", "collectorNumber": "string", "imageUrl": "string", "isSealed": true, "fromPrice": 0, "sellerCount": 0, "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.items[].productIdrequiredintegerNoneProduct Id for the surrounding items item record.0 (generated)
data.items[].namerequiredstring or nullNoneThe human-readable name of the resource.string (generated)
data.items[].setrequiredstring or nullNoneThe card set or expansion.string (generated)
data.items[].categoryrequiredstring or nullNoneThe trading-card game category.string (generated)
data.items[].rarityrequiredstring or nullNoneThe rarity assigned to the card printing.string (generated)
data.items[].collectorNumberrequiredstring or nullNoneCollector Number for the surrounding items item record.string (generated)
data.items[].imageUrlrequiredstring or nullNoneImage Url for the surrounding items item record.string (generated)
data.items[].isSealedrequiredbooleanNoneIs Sealed for the surrounding items item record.true (generated)
data.items[].fromPricerequiredintegerNoneMinimum offer price across sellers, in integer minor units (cents).0 (generated)
data.items[].sellerCountrequiredintegerNoneCount of distinct Sellers offering this Product.0 (generated)
data.items[].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.items[].disclosures.imageSourcerequiredstringallowed values: catalogImage Source for the surrounding disclosures record.catalog (generated)
data.items[].disclosures.conditionSourcerequiredstringallowed values: seller_declaredCondition Source for the surrounding disclosures record.seller_declared (generated)
data.items[].disclosures.authenticitySourcerequiredstringallowed values: seller_attestationAuthenticity Source for the surrounding disclosures record.seller_attestation (generated)
data.items[].disclosures.snapcasterInspectedrequiredbooleanallowed values: falseSnapcaster Inspected for the surrounding disclosures record.false (generated)
data.items[].disclosures.snapcasterGradedrequiredbooleanallowed values: falseSnapcaster Graded for the surrounding disclosures record.false (generated)
data.items[].disclosures.snapcasterAuthenticatedrequiredbooleanallowed values: falseSnapcaster Authenticated for the surrounding disclosures record.false (generated)
data.items[].disclosures.gradingStandardrequiredstringallowed values: snapcaster-magic-v1, seller-declared-no-specialist-promiseGrading Standard for the surrounding disclosures record.snapcaster-magic-v1 (generated)
data.items[].disclosures.declaredGraderequiredstring or nullNoneDeclared Grade for the surrounding disclosures record.string (generated)
data.items[].disclosures.buyerProtectionrequiredstringallowed values: magic-grade-and-authenticity, genuine-and-as-describedBuyer Protection for the surrounding disclosures record.magic-grade-and-authenticity (generated)
data.items[].fulfillmentObligationrequiredobject or nullNoneFulfillment Obligation for the surrounding items item record.{ "sku": "exact", "printing": "exact", "language": "exact", "finish": "exact", "condition": "declared-or-better" } (generated)
data.items[].fulfillmentObligation.skurequiredstringallowed values: exactThe stock-keeping identity for the exact card offering.exact (generated)
data.items[].fulfillmentObligation.printingrequiredstringallowed values: exactThe exact card printing the Seller is obligated to supply.exact (generated)
data.items[].fulfillmentObligation.languagerequiredstringallowed values: exactThe language of the card printing.exact (generated)
data.items[].fulfillmentObligation.finishrequiredstringallowed values: exactThe physical finish or foil treatment of the card.exact (generated)
data.items[].fulfillmentObligation.conditionrequiredstringallowed values: declared-or-betterThe normalized condition assigned to the card.declared-or-better (generated)
data.facetsrequiredobjectNoneAvailable filter values and their result counts.{ "category": [ { "value": "string", "count": 0 } ], "set": [ { "value": "string", "count": 0 } ], "rarity": [ { "value": "string", "count": 0 } ], "seller": [ { "sellerCode": "string", "storeName": "string", "count": 0 } ], "condition": [ { "value": "string", "count": 0 } ], "language": [ { "value": "string", "count": 0 } ], "finish": [ { "value": "string", "count": 0 } ], "collectorNumber": [ { "value": "string", "count": 0 } ] } (generated)
data.facets.categoryrequiredarray of objectNoneThe trading-card game category.[ { "value": "string", "count": 0 } ] (generated)
data.facets.category[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.category[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.setrequiredarray of objectNoneThe card set or expansion.[ { "value": "string", "count": 0 } ] (generated)
data.facets.set[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.set[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.rarityrequiredarray of objectNoneThe rarity assigned to the card printing.[ { "value": "string", "count": 0 } ] (generated)
data.facets.rarity[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.rarity[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.sellerrequiredarray of objectNoneStore facet: one entry per Seller with browsable Listings under the current query, carrying the public `sellerCode` to scope by and the store name to render. Both express (native) and manual (handoff) stores appear. Unlike the other facets a value needs two fields, so this one is not a plain { value, count }.[ { "sellerCode": "string", "storeName": "string", "count": 0 } ] (generated)
data.facets.seller[].sellerCoderequiredstringNoneThe store’s public handle — feed it back as the `sellerCode` query param to scope.string (generated)
data.facets.seller[].storeNamerequiredstringNoneThe store display name to render; not a handle/slug.string (generated)
data.facets.seller[].countrequiredintegerNoneNumber of the store’s Listings under the current query.0 (generated)
data.facets.conditionrequiredarray of objectNoneThe normalized condition assigned to the card.[ { "value": "string", "count": 0 } ] (generated)
data.facets.condition[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.condition[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.languagerequiredarray of objectNoneThe language of the card printing.[ { "value": "string", "count": 0 } ] (generated)
data.facets.language[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.language[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.finishrequiredarray of objectNoneThe physical finish or foil treatment of the card.[ { "value": "string", "count": 0 } ] (generated)
data.facets.finish[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.finish[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.facets.collectorNumberrequiredarray of objectNoneCollector Number for the surrounding facets record.[ { "value": "string", "count": 0 } ] (generated)
data.facets.collectorNumber[].valuerequiredstringNoneThe value represented by this entry.string (generated)
data.facets.collectorNumber[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
data.nextCursorrequiredstring or nullNoneOpaque keyset cursor for the next page; null on the last page.string (generated)

Examples

Generated Schema example: Generated BrowseSearchResponse
{
"success": true,
"data": {
"items": [
{
"productId": 0,
"name": "string",
"set": "string",
"category": "string",
"rarity": "string",
"collectorNumber": "string",
"imageUrl": "string",
"isSealed": true,
"fromPrice": 0,
"sellerCount": 0,
"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"
}
}
],
"facets": {
"category": [
{
"value": "string",
"count": 0
}
],
"set": [
{
"value": "string",
"count": 0
}
],
"rarity": [
{
"value": "string",
"count": 0
}
],
"seller": [
{
"sellerCode": "string",
"storeName": "string",
"count": 0
}
],
"condition": [
{
"value": "string",
"count": 0
}
],
"language": [
{
"value": "string",
"count": 0
}
],
"finish": [
{
"value": "string",
"count": 0
}
],
"collectorNumber": [
{
"value": "string",
"count": 0
}
]
},
"nextCursor": "string"
}
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9