IKAS icon

IKAS

Consume IKAS e-commerce platform API

Order → Update Package Status

AI-generated

Overview

This node operation updates the status of packages within a specified order in the IKAS e-commerce platform. It is useful for managing and tracking the delivery process of orders by changing package statuses such as Fulfilled, Delivered, Cancelled, Error, and others. For example, it can be used to mark packages as delivered or to report errors during shipment.

Use Case Examples

  1. Updating the status of multiple packages in an order to 'Delivered' after successful shipment.
  2. Marking a package as 'Error' with an accompanying error message if a delivery issue occurs.

Properties

Name Meaning
Order ID ID of the order containing packages to update, required to identify which order's packages are being updated.
Packages Collection of package status updates including package ID, new status, optional error message, source ID, and tracking information.

Output

JSON

  • orderId - The ID of the order for which package statuses were updated.
  • updatedPackages - Array of packages with their updated statuses and related information after the update operation.

Dependencies

  • IKAS e-commerce platform API with appropriate API key credentials

Troubleshooting

  • Ensure the Order ID is valid and exists in the IKAS system to avoid errors related to non-existent orders.
  • Verify that each package ID provided is correct and belongs to the specified order to prevent update failures.
  • Check that the status values are among the allowed options to avoid invalid status errors.
  • If using tracking information, ensure URLs and tracking numbers are correctly formatted to prevent notification or tracking issues.
  • Handle API errors gracefully, especially network or authentication errors, by verifying API credentials and connectivity.

Discussion