IKAS icon

IKAS

Consume IKAS e-commerce platform API

Actions12

Product → Search

AI-generated

Overview

This node operation allows searching for products within the IKAS e-commerce platform. It supports searching by various criteria such as product name, description, product IDs, SKUs, and barcodes. The node can either fetch all matching products automatically using pagination or limit the number of results and specify the page to retrieve. This is useful for scenarios where users want to find specific products or filter products based on search terms or identifiers.

Use Case Examples

  1. Search for products by name or description using a search query.
  2. Retrieve products by specifying a list of product IDs, SKUs, or barcodes.
  3. Automatically fetch all products matching the search criteria across multiple pages.
  4. Limit the search results to a specific number and page for targeted retrieval.

Properties

Name Meaning
Fetch All Items Whether to automatically fetch all items using pagination. When enabled, the node will continue fetching pages until all data is retrieved.
Limit Maximum number of results to return when not fetching all items automatically.
Page Page number for pagination (starts from 1) when not fetching all items automatically.
Page Size Number of items to fetch per page when auto-fetching all items.
Search Query Search term to find products by name, description, or other text fields.
Product IDs Comma-separated list of product IDs to search for.
SKU List Comma-separated list of SKUs to search for.
Barcode List Comma-separated list of barcodes to search for.

Output

JSON

  • id - Unique identifier of the product
  • name - Name of the product
  • description - Description of the product
  • sku - Stock Keeping Unit identifier for the product variant
  • barcodeList - List of barcodes associated with the product variant
  • price - Price details of the product
  • stock - Stock availability information
  • variants - List of product variants with their details

Dependencies

  • IKAS e-commerce platform API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access product data.
  • If no products are returned, verify that the search query or filters (product IDs, SKUs, barcodes) are correctly specified and match existing products.
  • Pagination parameters (limit, page, pageSize) should be set appropriately to avoid empty or incomplete results.
  • Common error messages may include authentication errors, invalid parameters, or network issues. Check the error message details and verify the node configuration and API connectivity.

Links

  • IKAS API Documentation - Official documentation for the IKAS e-commerce platform API, including product search endpoints and parameters.

Discussion