Products

Products Management

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

Product Retrieval

Get All Products

  • Endpoint: /get_products
  • Description: This endpoint is designed to retrieve the complete list of products available in our database, providing a comprehensive overview of all products without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 products at a time.
    • Parameters:
    • offset - Specify the starting point of the row from which to begin fetching products.
    • limit - Control the number of products 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 product information.



Filters

Filter By Discounted Products

  • Endpoint: /get_products
  • Description: Use this endpoint to fetch products currently available with discounts. This is particularly useful for marketing or promotional purposes.
  • Parameter: only_return_discounted_items=1 - Set this parameter to 1 to filter only discounted items.
  • Full Documentation and Practical Examples: Filter By Discounted Products

Filter By Product IDs

  • Endpoint: /get_products
  • Description: If you have specific product IDs and need detailed information about those products, use this endpoint. It filters products based on the provided product IDs.
  • Parameters: IN[]=pid - Use this parameter to specify product IDs. You can include multiple IN[] parameters for different product IDs.
  • Full Documentation and Practical Examples: Filter By Product IDs

Category and Brand-Based Filtering

Filter By Category IDs

  • Endpoint: /get_products
  • Description: This endpoint allows you to retrieve products based on their category IDs. It's handy when you need to display products from specific categories.
  • Parameters: cid[]=category_id - Specify category IDs using this parameter. You can include multiple cid[] parameters for different categories.
  • Full Documentation and Practical Examples: Filter By Category IDs

Filter By Brand IDs

  • Endpoint: /get_products
  • Description: Similar to category-based filtering, this endpoint focuses on brand IDs. Use it to filter products according to their brands.
  • Parameters: bid[]=brand_id - Use this parameter to specify brand IDs. Include multiple bid[] parameters for filtering by different brands.
  • Full Documentation and Practical Examples: Filter By Brand IDs

Setting Product Information

Set Products

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

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