HomeGuidesAPI Endpoints
GuidesAPI EndpointsCommunityLog In

Search Category Products

This endpoint returns an array of product Ids that match the provided search critera.
Use the search manifest from the GET /catalog/categories/{categoryId}/search/manifest
endpoint to build requests to this endpoint. If an invalid filter name is specified
in the request, it will be ignored. Use the GET /catalog/products/{productIds}
endpoint to get the details about the returned product Ids.

📘

Application Performance Note

While this endpoint can be super useful for searching for specific products, the highest performance for end users involves caching a local database and writing searches that work on a local database.

{
  "sort": "string",
  "limit": 0,
  "offset": 0,
  "filters": [
    {
      "name": "string",
      "values": [
        "string"
      ]
    }
  ]
}
{
  "totalItems": 0,
  "success": true,
  "errors": [
    "string"
  ],
  "results": [
    0
  ]
}
/catalog/categories/24/search

Headers:
Authorization | {{bearerToken}}
Content-Type | application/json

Body:
{
    "sort": "MinPrice DESC",
    "limit": 10,
    "offset": 0,
    "filters": [
        {
            "name": "ProductName",
            "values": [ "Aerith"]
        },
        {
            "name": "Rarity",
            "values": [ "Rare", "Legend", "Hero", "Promo" ]
        },
        {
            "name": "Category",
            "values": [ "VII"]
        }
    ]
}

Response:
{
    "totalItems": 2,
    "success": true,
    "errors": [],
    "results": [
        137942,
        132438
    ]
}
Language
Click Try It! to start a request and see the response here!