Inventory & Products | 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 Product

  • Endpoint: /set_product
  • Description: Unified endpoint for creating, updating, or upserting products. Supports single product operations and bulk operations via products array.
  • Behavior:
    • UPDATE: When pid is provided and product exists in database
    • UPSERT: When pid is provided but product doesn't exist - creates new product with specified PID
    • CREATE: When pid is not provided or empty - creates new product with auto-generated PID
    • BULK: When products array is provided - processes multiple products
  • Full Documentation and Practical Examples: Set Product

Product Multi-Configurations

Get Products Multi

  • Endpoint: /get_products_multi
  • Description: This endpoint retrieves multi-product configurations, which handle products with multiple variants, codes, or supplier configurations. Each multi-product record can have its own price, stock, location, and barcode.
  • Usage Notes:
    • Pagination: Supports fetching up to 50 multi-products at a time.
    • Filters: Can filter by pid (product ID), multi_code, and supplier_id.
  • Full Documentation and Practical Examples: Get Products Multi

Product Tags

Get Product Tags

  • Endpoint: /get_product_tags
  • Description: This endpoint retrieves product tags, which are used for categorization and labeling of products. Tags help in organizing and searching products based on custom attributes.
  • Full Documentation and Practical Examples: Get Product Tags

Product Costs

Get Products Costs

  • Endpoint: /get_products_costs
  • Description: This endpoint retrieves detailed cost information for products, including various cost components like customs fees, transportation costs, warehousing, and more.
  • Usage Notes:
    • Required Parameter: pid (product ID) is required.
  • Full Documentation and Practical Examples: Get Products Costs

Product Bundles

Get Product Bundles

  • Endpoint: /get_product_bundles
  • Description: This endpoint retrieves the bundle items (child products) for a given parent product. Each bundle item includes the child product details (pid, name, price, barcode, etc.).
  • Usage Notes:
    • Required Parameter: pid (product ID of the bundle/parent product).
    • Pagination: Supports fetching up to 50 bundle items at a time.
  • Full Documentation and Practical Examples: Get Product Bundles

Set Product Bundles

  • Endpoint: /set_product_bundles
  • Description: This endpoint allows creating, updating, or deleting bundle items for a product. Supports bulk operations and automatically manages the is_bundle flag on the parent product.
  • Usage Notes:
    • Required Parameter: pid (product ID of the bundle/parent product).
    • Operations: Add items, update items, delete items, or replace all items.
  • Full Documentation and Practical Examples: Set Product Bundles

Product Stock Management

Get Products Stock

  • Endpoint: /get_products_stock
  • Description: This endpoint retrieves stock information for products, including stock levels at specific locations and shelves. Use this to track inventory across your warehouse locations.
  • Usage Notes:
    • Required Parameter: pid (product ID) is required.
    • Optional Filters: location_id and shelf_id for location-specific stock queries.
  • Full Documentation and Practical Examples: Get Products Stock

Set Products Stock

  • Endpoint: /set_products_stock
  • Description: This endpoint allows updating product stock levels. Supports stock additions (positive values) and deductions (negative values) with reference tracking for audit purposes.
  • Usage Notes:
    • Required Parameters: pid (product ID) and stock change value.
    • Reference Tracking: Include order IDs or invoice numbers for traceability.
  • Full Documentation and Practical Examples: Set Products Stock

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