IKAS icon

IKAS

Consume IKAS e-commerce platform API

Overview

This node integrates with the IKAS e-commerce platform API to fulfill orders. It allows users to specify an order by its ID and fulfill specific line items within that order, optionally marking the order as ready for shipment, sending notifications to customers, and providing detailed tracking information.

Common scenarios where this node is beneficial include automating order fulfillment workflows in e-commerce operations, updating order statuses after packing, and notifying customers about their shipments with tracking details.

Practical examples:

  • Automatically fulfilling selected items of an order once inventory is confirmed.
  • Marking orders as ready for shipment and sending notifications to customers without manual intervention.
  • Adding tracking numbers and shipping company details to orders to keep customers informed.

Properties

Name Meaning
Order ID ID of the order to fulfill (string, required).
Order Line Items Collection of line items to fulfill, each with:
- Order Line Item ID (string, required): Identifier of the specific line item to fulfill.
- Quantity (number, required, min 1): Number of units to fulfill for that line item.
Mark as Ready for Shipment Boolean flag indicating whether to mark the order as ready for shipment.
Send Notification to Customer Boolean flag indicating whether to send a notification to the customer about the fulfillment.
Source Package ID Optional string specifying the ID of the source package related to the fulfillment.
Tracking Information Collection of optional tracking details including:
- Barcode (string): Barcode for the shipment.
- Cargo Company (string): Name of the cargo/shipping company.
- Cargo Company ID (string): Identifier of the cargo/shipping company.
- Send Tracking Notification (boolean): Whether to send tracking notification to the customer.
- Tracking Link (string): URL link to track the shipment.
- Tracking Number (string): Tracking number for the shipment.

Output

The node outputs JSON data representing the result of the fulfillment operation. This typically includes confirmation details about the fulfilled order or updated order status.

If multiple input items are processed, the output will be an array of such JSON objects corresponding to each input.

The node does not output binary data.

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.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing Order ID or Order Line Item IDs can cause errors.
    • Attempting to fulfill quantities exceeding available stock may result in API errors.
    • Network or authentication failures with the IKAS API will prevent fulfillment.
  • Error messages:

    • "Resource "order" is not yet implemented" or "Operation "fulfill" is not yet implemented for resource "order" indicate misconfiguration or unsupported operations.
    • API errors returned from IKAS will be surfaced; ensure credentials and parameters are correct.
  • Resolutions:

    • Verify all required fields are provided and valid.
    • Check API credentials and network connectivity.
    • Use the node's "Continue On Fail" option to handle partial failures gracefully.

Links and References

Discussion