Categories

Categories Management

This section provides a comprehensive guide to managing the categories in our system. You will find various options for retrieving, filtering, and setting category information, each tailored to different requirements.

Category Retrieval

Get All Categories

  • Endpoint: /get_categories
  • Description: This endpoint is designed to retrieve the complete list of categories available in our database, providing a comprehensive overview of all categories without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 categories at a time.
    • Parameters:
    • offset - Specify the starting point of the row from which to begin fetching categories.
    • limit - Control the number of categories returned in a single request. The maximum limit is 50, but you can opt for a smaller number based on your needs.
    • Method: This functionality can be utilized by including payload or parameters in your POST request to manage the offset and limit.

These features are particularly useful for handling large datasets and for applications requiring batch processing of category information.



Filters

IN / NOT_IN Filter

  • Endpoint: /get_categories
  • Description: Use this endpoint to filter categories based on specific category IDs. It supports both inclusion (IN) and exclusion (NOT_IN) filters for category IDs.
  • Parameters:
    • IN - Specify the category IDs to include specific categories.
    • NOT_IN - Specify the category IDs to exclude specific categories.
    • You can use these parameters as arrays or single integers for more flexibility.
  • Full Documentation and Practical Examples: IN / NOT_IN Filter

Setting Category Information

Set Categories

  • Endpoint: /set_categories
  • Description: This is a crucial endpoint for updating or adding new categories to the database. It supports both insertion of new category details and updating existing ones.
  • Full Documentation and Practical Examples: Set Categories

For further assistance or API integration support, please refer to our API Documentation or contact our technical support team.