Search Vendor Category
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 isbudget 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
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
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.
