Actions11
Overview
This node integrates with the IKAS e-commerce platform API to update the status of packages within a specific order. It is useful in scenarios where you need to programmatically track and manage the lifecycle of shipments, such as marking packages as delivered, cancelled, or ready for shipment.
Practical examples include:
- Automatically updating package statuses after receiving shipping updates from a logistics provider.
- Marking packages as "Error" with an error message if delivery fails.
- Sending tracking information and notifications to customers when packages are shipped.
Properties
| Name | Meaning |
|---|---|
| Order ID | The unique identifier of the order containing the packages to update. This is required to specify which order's packages will be updated. |
| Packages | A collection of one or more package updates. Each package update includes: - Package ID (required): Identifier of the package to update. - Status (required): New status of the package. Options: Cancel Rejected, Cancel Requested, Cancelled, Delivered, Error, Fulfilled, Ready for Pick Up, Ready for Shipment, Refund Rejected, Refund Request Accepted, Refund Requested, Refunded, Unable to Deliver. - Error Message (optional): Description of an error, typically used when status is "Error". - Source ID (optional): Source identifier for the update. - Tracking Information (optional): Details about shipment tracking including barcode, cargo company name and ID, tracking number, tracking link, and whether to send a notification to the customer. |
| Global Source ID | An optional global source identifier for the entire update operation, useful for correlating multiple package updates under a single source reference. |
Output
The node outputs JSON data representing the result of the package status update operation. Typically, this includes confirmation details of the updated packages or any errors encountered during the update process.
If the node supports binary data output (not explicitly shown in the provided code), it would generally relate to attachments or documents associated with the order or packages, but no binary output is indicated here.
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 services or environment variables are explicitly required beyond the API authentication.
Troubleshooting
Common Issues:
- Invalid or missing Order ID: The node requires a valid order identifier; ensure the Order ID corresponds to an existing order.
- Incorrect Package IDs: Package IDs must match those in the specified order; otherwise, updates may fail.
- Invalid status values: Status must be one of the predefined options; using unsupported statuses will cause errors.
- Network or authentication errors: Ensure the API key credential is valid and has sufficient permissions.
Error Messages:
"Resource "order" is not yet implemented"or"Operation "updatePackageStatus" is not yet implemented for resource "order"": These indicate misconfiguration or unsupported operations; verify that the node version supports this operation.- API response errors related to invalid input or authorization will be passed through; check the error message for details and correct inputs accordingly.
Links and References
- IKAS e-commerce platform API documentation (assumed URL based on baseURL)
- n8n documentation on creating custom nodes
- General guidance on handling package status workflows (external resource for context)