Skip to content
snapcasterDevelopers

BrowseFacets

Reusable BrowseFacets schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
categoryrequiredarray of objectNoneThe trading-card game category.[ { "value": "string", "count": 0 } ] (generated)
category[].valuerequiredstringNoneThe value represented by this entry.string (generated)
category[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
setrequiredarray of objectNoneThe card set or expansion.[ { "value": "string", "count": 0 } ] (generated)
set[].valuerequiredstringNoneThe value represented by this entry.string (generated)
set[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
rarityrequiredarray of objectNoneThe rarity assigned to the card printing.[ { "value": "string", "count": 0 } ] (generated)
rarity[].valuerequiredstringNoneThe value represented by this entry.string (generated)
rarity[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
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)
seller[].sellerCoderequiredstringNoneThe store’s public handle — feed it back as the `sellerCode` query param to scope.string (generated)
seller[].storeNamerequiredstringNoneThe store display name to render; not a handle/slug.string (generated)
seller[].countrequiredintegerNoneNumber of the store’s Listings under the current query.0 (generated)
conditionrequiredarray of objectNoneThe normalized condition assigned to the card.[ { "value": "string", "count": 0 } ] (generated)
condition[].valuerequiredstringNoneThe value represented by this entry.string (generated)
condition[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
languagerequiredarray of objectNoneThe language of the card printing.[ { "value": "string", "count": 0 } ] (generated)
language[].valuerequiredstringNoneThe value represented by this entry.string (generated)
language[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
finishrequiredarray of objectNoneThe physical finish or foil treatment of the card.[ { "value": "string", "count": 0 } ] (generated)
finish[].valuerequiredstringNoneThe value represented by this entry.string (generated)
finish[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)
collectorNumberrequiredarray of objectNoneCollector Number supplied to or returned by this operation.[ { "value": "string", "count": 0 } ] (generated)
collectorNumber[].valuerequiredstringNoneThe value represented by this entry.string (generated)
collectorNumber[].countrequiredintegerNoneNumber of Products carrying this value under the current query.0 (generated)

Examples

Generated Schema example: Generated BrowseFacets
{
"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
}
]
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9