IKAS icon

IKAS

Consume IKAS e-commerce platform API

Overview

This node integrates with the IKAS e-commerce platform API to perform various operations on products, orders, and webhooks. Specifically, for the Product - Search operation, it allows users to search for products based on multiple criteria such as product IDs, SKUs, barcodes, or a general search query. It supports pagination and can automatically fetch all matching items by iterating through pages.

Common scenarios where this node is beneficial include:

  • Retrieving product details for inventory management.
  • Searching for specific products by SKU or barcode in bulk.
  • Integrating product data into other workflows like order processing or reporting.
  • Automating synchronization of product catalogs between IKAS and other systems.

Practical example:

  • A user wants to find all products containing "blue shirt" in their name or description and process them further in a workflow. They can use this node to search with the term "blue shirt" and fetch all matching products automatically.

Properties

Name Meaning
Fetch All Items Whether to automatically fetch all matching products using pagination. If enabled, the node will keep fetching pages until all results are retrieved.
Limit Maximum number of results to return (only used if "Fetch All Items" is disabled). Options: 10, 20, 30, 40, 50.
Page Page number to retrieve when pagination is manual (starts from 1). Only relevant if "Fetch All Items" is false.
Page Size Number of items to fetch per page when auto-fetching all items. Options: 10, 20, 30, 40, 50.
Search Query Text string to search 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

The node outputs an array of product objects in the json field. Each object represents a product matching the search criteria and includes detailed product information as returned by the IKAS API.

If multiple products are found, the output contains multiple JSON objects, each corresponding to one product.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating with the IKAS e-commerce platform API.
  • The node communicates with the IKAS API endpoint at https://api.myikas.com/api/v1/admin.
  • Uses GraphQL queries internally to fetch product data.
  • No additional external dependencies beyond the IKAS API and n8n's standard environment.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid product IDs, SKUs, or barcodes may result in empty search results.
    • Network connectivity issues can prevent the node from reaching the IKAS API.
    • Pagination parameters misconfiguration (e.g., setting page number less than 1) may cause errors.
  • Error messages:

    • "Resource "product" is not yet implemented": Indicates the resource parameter is incorrect or unsupported.
    • "Operation "search" is not yet implemented for resource "product": Means the operation parameter is invalid or not supported for the product resource.
    • API errors returned from IKAS will be propagated; check the error message for details such as authentication failure or rate limiting.
  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Double-check input parameters for correct formatting and valid values.
    • Ensure network access to the IKAS API endpoint.
    • Use the "Fetch All Items" option carefully to avoid excessive API calls or timeouts.

Links and References

Discussion