Skip to navigation

Search Vendor Category

View as Markdown

Search Vendor Category

This endpoint allows users to search for vendor categories based on a query string.

Request

  • Method: GET

  • Endpoint: {{host}}/apis/external/search/searchVendorCategory

  • Query Parameters:

    • q (string): The search term used to look for vendor categories. In this example, the query is budget category.

Response

The response will be in JSON format and contains the following structure:

  • categories (array): An array of category objects that match the search query.

    • Each category object includes:

      • id (integer): The unique identifier for the category.

      • name (string): The name of the category.

Example Response

{
"categories": [
{
"id": 1961,
"name": "budget category"
}
]
}

Notes

  • The response will return an array of categories, which may be empty if no matches are found.

  • Ensure that the query parameter is properly URL-encoded if it contains special characters.

Query parameters

qstringOptional

Searches vendor categories using the q parameter by performing a case-insensitive partial match on the category name. Returns an empty response if q is blank.

Response headers

request-idstringOptional

Response

OK
categorieslist of objects