CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Overview

This node interacts with a cloud commerce platform to perform operations on various resources such as customers, subscriptions, orders, and plans. Specifically, for the Order resource with the Get operation, it retrieves detailed information about a single order by its unique identifier. This is useful in scenarios where you need to fetch order details for processing, reporting, or integration with other systems.

Practical examples include:

  • Retrieving an order's status and details before updating or fulfilling it.
  • Fetching order information to display in a dashboard or send notifications.
  • Integrating order data into CRM or ERP systems.

Properties

Name Meaning
Order ID The unique identifier of the order to retrieve. This is a required string input.

Output

The node outputs JSON data representing the order details fetched from the external service. The structure of this JSON depends on the external API response but typically includes fields such as order ID, customer info, order status, items, pricing, and dates.

If multiple orders were retrieved (in other operations), the output would be an array of such JSON objects, but for the Get operation, it returns a single JSON object per input item.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API authentication token or key configured in n8n to connect to the cloud commerce platform.
  • Depends on an internal API service initialization utility to establish communication with the external system.
  • Uses a resource registry to manage supported resources and their operations.

Troubleshooting

  • Resource not found error: If the specified resource (e.g., "order") is not recognized, ensure that the node supports it and that the resource name is correctly spelled.
  • Unexpected error: Resource exists but instance not found: Indicates an internal inconsistency; try restarting n8n or reinstalling the node package.
  • API errors: Errors returned from the external service (e.g., invalid order ID) will be surfaced. Verify that the Order ID is correct and that the API credentials have sufficient permissions.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

  • No direct external links are provided in the source code.
  • For more details on the cloud commerce platform API, consult the official API documentation of the respective service integrated by this node.

Discussion