HomeGuidesAPI Endpoints
GuidesAPI EndpointsCommunityLog In

Get Category Search Manifest

This endpoint returns a search manifest for the specified category. The search
manifest describes all of the sorting options and filters that are available for
this category. Its contents should be used to build requests to the POST
/catalog/categories/{categoryId}/search endpoint.

The search manifest is useful for returning data about which fields can be used with the search endpoints. Different products have different filters available and this endpoint simplifies the process of writing advanced searches.

{
  "success": true,
  "errors": [
    "string"
  ],
  "results": [
    {
      "sorting": [
        {
          "text": "string",
          "value": "string"
        }
      ],
      "filters": [
        {
          "name": "string",
          "displayName": "string",
          "inputType": "string",
          "items": [
            {
              "text": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ]
}
/catalog/categories/24/search/manifest

Headers:
Authorization | {{bearerToken}}

Response:
{
    "success": true,
    "errors": [],
    "results": [
        {
            "sorting": [
                {
                    "text": "A-Z",
                    "value": "ProductName ASC"
                },
                {
                    "text": "Price: High to Low",
                    "value": "MinPrice DESC"
                },
                {
                    "text": "Price: Low to High",
                    "value": "MinPrice ASC"
                },
                {
                    "text": "Relevance",
                    "value": "Relevance"
                },
                {
                    "text": "Best Selling",
                    "value": "Sales DESC"
                }
            ],
            "filters": [
                {
                    "name": "ProductName",
                    "displayName": "Name",
                    "inputType": "Text",
                    "items": []
                },
                {
                    "name": "Description",
                    "displayName": "Description",
                    "inputType": "Text",
                    "items": []
                },
                {
                    "name": "SetName",
                    "displayName": "Set",
                    "inputType": "SingleValue",
                    "items": [
                        {
                            "text": "Any",
                            "value": ""
                        },
                        {
                            "text": "Deck Exclusive Cards",
                            "value": "Deck Exclusive Cards"
                        },
                        {
                            "text": "FF: Promo Cards",
                            "value": "FF: Promo Cards"
                        },
                        {
                            "text": "Opus I",
                            "value": "Opus I"
                        },
                        {
                            "text": "Opus II",
                            "value": "Opus II"
                        },
                        {
                            "text": "Opus III",
                            "value": "Opus III"
                        },
                        {
                            "text": "Opus IV",
                            "value": "Opus IV"
                        },
                        {
                            "text": "Opus V",
                            "value": "Opus V"
                        },
                        {
                            "text": "Opus VI",
                            "value": "Opus VI"
                        },
                        {
                            "text": "Opus VII",
                            "value": "Opus VII"
                        },
                        {
                            "text": "Opus VIII",
                            "value": "Opus VIII"
                        }
                    ]
                },
                {
                    "name": "Rarity",
                    "displayName": "Rarity",
                    "inputType": "MultipleValues",
                    "items": [
                        {
                            "text": "Rare",
                            "value": "Rare"
                        },
                        {
                            "text": "Common",
                            "value": "Common"
                        },
                        {
                            "text": "Legend",
                            "value": "Legend"
                        },
                        {
                            "text": "Hero",
                            "value": "Hero"
                        },
                        {
                            "text": "Starter",
                            "value": "Starter"
                        },
                        {
                            "text": "Promo",
                            "value": "Promo"
                        },
                        {
                            "text": "None",
                            "value": "None"
                        }
                    ]
                },
                {
                    "name": "CardType",
                    "displayName": "Card Type",
                    "inputType": "SingleValue",
                    "items": [
                        {
                            "text": "Any",
                            "value": ""
                        },
                        {
                            "text": "Backup",
                            "value": "Backup"
                        },
                        {
                            "text": "Forward",
                            "value": "Forward"
                        },
                        {
                            "text": "Monster",
                            "value": "Monster"
                        },
                        {
                            "text": "Summon",
                            "value": "Summon"
                        }
                    ]
                },
                {
                    "name": "Element",
                    "displayName": "Element",
                    "inputType": "SingleValue",
                    "items": [
                        {
                            "text": "Any",
                            "value": ""
                        },
                        {
                            "text": "Dark",
                            "value": "Dark"
                        },
                        {
                            "text": "Earth",
                            "value": "Earth"
                        },
                        {
                            "text": "Fire",
                            "value": "Fire"
                        },
                        {
                            "text": "Ice",
                            "value": "Ice"
                        },
                        {
                            "text": "Light",
                            "value": "Light"
                        },
                        {
                            "text": "Lightning",
                            "value": "Lightning"
                        },
                        {
                            "text": "Water",
                            "value": "Water"
                        },
                        {
                            "text": "Wind",
                            "value": "Wind"
                        }
                    ]
                },
                {
                    "name": "Cost",
                    "displayName": "Cost",
                    "inputType": "SingleValue",
                    "items": [
                        {
                            "text": "Any",
                            "value": ""
                        },
                        {
                            "text": "1",
                            "value": "1"
                        },
                        {
                            "text": "2",
                            "value": "2"
                        },
                        {
                            "text": "3",
                            "value": "3"
                        },
                        {
                            "text": "4",
                            "value": "4"
                        },
                        {
                            "text": "5",
                            "value": "5"
                        },
                        {
                            "text": "6",
                            "value": "6"
                        },
                        {
                            "text": "7",
                            "value": "7"
                        },
                        {
                            "text": "8",
                            "value": "8"
                        },
                        {
                            "text": "9",
                            "value": "9"
                        }
                    ]
                },
                {
                    "name": "Job",
                    "displayName": "Job",
                    "inputType": "Text",
                    "items": []
                },
                {
                    "name": "Category",
                    "displayName": "Category",
                    "inputType": "SingleValue",
                    "items": [
                        {
                            "text": "Any",
                            "value": ""
                        },
                        {
                            "text": "I",
                            "value": "I"
                        },
                        {
                            "text": "II",
                            "value": "II"
                        },
                        {
                            "text": "III",
                            "value": "III"
                        },
                        {
                            "text": "IV",
                            "value": "IV"
                        },
                        {
                            "text": "V",
                            "value": "V"
                        },
                        {
                            "text": "VI",
                            "value": "VI"
                        },
                        {
                            "text": "VII",
                            "value": "VII"
                        },
                        {
                            "text": "VIII",
                            "value": "VIII"
                        },
                        {
                            "text": "IX",
                            "value": "IX"
                        },
                        {
                            "text": "X",
                            "value": "X"
                        },
                        {
                            "text": "XI",
                            "value": "XI"
                        },
                        {
                            "text": "XII",
                            "value": "XII"
                        },
                        {
                            "text": "XIII",
                            "value": "XIII"
                        },
                        {
                            "text": "XIV",
                            "value": "XIV"
                        },
                        {
                            "text": "XV",
                            "value": "XV"
                        },
                        {
                            "text": "DFF",
                            "value": "DFF"
                        },
                        {
                            "text": "Dissidia",
                            "value": "Dissidia"
                        },
                        {
                            "text": "FFBE",
                            "value": "FFBE"
                        },
                        {
                            "text": "FFCC",
                            "value": "FFCC"
                        },
                        {
                            "text": "FFL",
                            "value": "FFL"
                        },
                        {
                            "text": "FFT",
                            "value": "FFT"
                        },
                        {
                            "text": "FFTA",
                            "value": "FFTA"
                        },
                        {
                            "text": "FFTA2",
                            "value": "FFTA2"
                        },
                        {
                            "text": "Theatrhythm",
                            "value": "Theatrhythm"
                        },
                        {
                            "text": "Type-0",
                            "value": "Type-0"
                        },
                        {
                            "text": "World of Final Fantasy",
                            "value": "World of Final Fantasy"
                        },
                        {
                            "text": "Lord of Vermilion",
                            "value": "Lord of Vermilion"
                        },
                        {
                            "text": "Mobius",
                            "value": "Mobius"
                        },
                        {
                            "text": "Pictlogica",
                            "value": "Pictlogica"
                        },
                        {
                            "text": "Special",
                            "value": "Special"
                        }
                    ]
                },
                {
                    "name": "Price",
                    "displayName": "Price",
                    "inputType": "Price",
                    "items": []
                }
            ]
        }
    ]
}
Language
Click Try It! to start a request and see the response here!