snapcasterDevelopers

    API reference · Types

    BrowseFacets

    Part of the response of GET /search.

    Type: object

    Example

    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
    }
  ]
}

    Fields

    category BrowseFacetValue[] required

    The trading-card game category.

    Show child fieldsHide child fields
    category[].value string required
    category[].count integer required

    Number of products carrying this value under the current query.

    set BrowseFacetValue[] required

    The card set or expansion.

    Show child fieldsHide child fields
    set[].value string required
    set[].count integer required

    Number of products carrying this value under the current query.

    rarity BrowseFacetValue[] required

    The rarity assigned to the card printing.

    Show child fieldsHide child fields
    rarity[].value string required
    rarity[].count integer required

    Number of products carrying this value under the current query.

    seller BrowseSellerFacetValue[] required

    One entry per seller with browsable listings matching the query. Each entry includes sellerCode for filtering and the store name for display, plus its count. Includes both express and manual stores. Other facets use { value, count }.

    Show child fieldsHide child fields
    seller[].sellerCode string required

    The store's public handle. Pass it as the sellerCode query parameter to filter results to this store.

    seller[].storeName string required

    The store's display name. Use sellerCode as its identifier.

    seller[].count integer required

    Number of the store’s listings under the current query.

    handoffStore array of object

    Eligible Shopify handoff stores with matching offers. New responses always include this array, including when empty; optional for compatibility with older responses.

    Show child fieldsHide child fields
    handoffStore[].storeSlug string required

    The Shopify handoff store identity. Pass it as storeSlug, mutually exclusive with sellerCode.

    handoffStore[].storeName string required
    handoffStore[].count integer required

    Matching offer-document count for this store, independent of pagination.

    condition BrowseFacetValue[] required

    The normalized condition assigned to the card.

    Show child fieldsHide child fields
    condition[].value string required
    condition[].count integer required

    Number of products carrying this value under the current query.

    language BrowseFacetValue[] required

    The language of the card printing.

    Show child fieldsHide child fields
    language[].value string required
    language[].count integer required

    Number of products carrying this value under the current query.

    finish BrowseFacetValue[] required

    The physical finish or foil treatment of the card.

    Show child fieldsHide child fields
    finish[].value string required
    finish[].count integer required

    Number of products carrying this value under the current query.

    collectorNumber BrowseFacetValue[] required
    Show child fieldsHide child fields
    collectorNumber[].value string required
    collectorNumber[].count integer required

    Number of products carrying this value under the current query.

    Used by