snapcasterDevelopers

    API reference · Types

    BrowseProductMeta

    Card metadata; null when no catalog row exists.

    Type: object or null

    Example

    Schema example: from the GET /products/{productId} response
    {
  "productId": 86,
  "name": "Abyssal Nightstalker",
  "set": "Portal Second Age",
  "rarity": "U",
  "collectorNumber": null,
  "imageUrl": "https://tcgplayer-cdn.tcgplayer.com/product/86_200w.jpg",
  "details": [
    {
      "label": "Rarity",
      "value": "U",
      "runs": [
        {
          "type": "text",
          "text": "U",
          "emphasis": false
        }
      ]
    },
    {
      "label": "P",
      "value": "2",
      "runs": [
        {
          "type": "text",
          "text": "2",
          "emphasis": false
        }
      ]
    }
  ]
}

    Fields

    productId integer required

    See Canonical catalog in Core concepts.

    Example 86

    name string or null required

    Example Abyssal Nightstalker

    set string or null required

    The product group or set name.

    Example Portal Second Age

    rarity string or null required

    Derived from the extended_data Rarity entry.

    Example U

    collectorNumber string or null required

    Derived from the extended_data Number entry.

    Example null

    imageUrl string or null required

    The catalog product image.

    Example https://tcgplayer-cdn.tcgplayer.com/product/86_200w.jpg

    details BrowseProductDetail[] required

    Each extended_data entry as { label, value, runs }.

    Show child fieldsHide child fields
    details[].label string required

    The entry's displayName, or its machine name if no display name exists.

    Example Rarity

    details[].value string required

    Plain text with markup removed; each line break is a newline.

    Example U

    details[].runs BrowseProductDetailRun[] required

    The value as text runs and line breaks, with emphasis marking text the catalog emphasized.

    Show child fieldsHide child fields
    details[].runs[].type string required

    Constraints: allowed values: text, break Example text

    details[].runs[].text string conditional

    Required when type is text.

    Example U

    details[].runs[].emphasis boolean conditional

    Required when type is text.

    Example false

    Used by