Card list entries

A card list entry is a single card within a card list. Its card variant entries determine which variants of that card are part of the card list.

Card list entries are replaced using the cms replace card-list-entries command:

tcgc cms replace card-list-entries <card-list-id> <card-list-entries-file-path>

Unlike resources, card list entries are specific to the CMS, because they identify cards and card variants by their TCG Collector IDs. A single file holds all entries of one card list. Each card list entry has the following properties:

Property	Type	Is required	Description
cardId	int64	Yes	The TCG Collector card ID.
cardNumber	string|null	No	Overrides the number of the card within the card list (the default is the number of the card itself).
cardVariantEntries	CardListEntryCardVariantEntry[]	Yes	An empty array means the card isn't part of the card list (removal).
sortingOrder	int32|null	No	The sorting order of the card within the card list, starting at 1. No two card list entries can share a sorting order.

Only the cards in the given file are affected, so the file doesn't have to describe the complete card list. Each card list entry is created if it doesn't exist yet, and completely replaced if it does.

The cms show cards and cms show card-variants commands can be used to look up the needed card and card variant IDs.

CardListEntryCardVariantEntry

Property	Type	Is required	Description
cardVariantId	int64	Yes	The TCG Collector card variant ID. It must belong to the card of the card list entry, and no two card variant entries can share a card variant ID.
quantity	int32|null	No	The quantity of the card variant within the card list. Defaults to 1.

Example

[
  {
    "cardId": 24601,
    "cardNumber": "1",
    "cardVariantEntries": [
      {
        "cardVariantId": 78201,
        "quantity": 1
      },
      {
        "cardVariantId": 78202,
        "quantity": 1
      }
    ],
    "sortingOrder": 1
  },
  {
    "cardId": 24602,
    "cardVariantEntries": [
      {
        "cardVariantId": 78203
      }
    ],
    "sortingOrder": 2
  },
  {
    "cardId": 24603,
    "cardVariantEntries": []
  }
]