CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Overview

This node interacts with a commerce platform to perform various operations on different resources such as customers, subscriptions, orders, and plans. Specifically, for the Order resource with the Estimate operation, it calculates an estimated cost or summary for an order before actual creation. This is useful in scenarios where you want to preview pricing, taxes, discounts, or other order-related details without committing the order.

Practical examples include:

  • E-commerce platforms estimating order totals before checkout.
  • B2B portals providing quotes based on selected products and quantities.
  • Internal tools validating order configurations and pricing rules.

Properties

Name Meaning
Order Data Contains the details of the order to estimate.
- Customer ID The unique identifier of the customer placing the order.
- Products A list of products included in the order.
-- MPN Manufacturer Part Number identifying each product.
-- Quantity The quantity of each product to be ordered.

The "Order Data" property is a fixed collection requiring:

  • A customer ID string.
  • One or more products, each specified by their MPN (string) and quantity (number).

Output

The node outputs JSON data representing the estimated order details. This typically includes calculated prices, taxes, discounts, and any other relevant metadata returned by the commerce platform's estimate API.

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

No binary data output is indicated.

Dependencies

  • Requires connection to the commerce platform's API via an initialized API service.
  • Needs proper authentication credentials (e.g., an API key or token) configured in n8n to authorize requests.
  • Relies on internal resource registry and utility modules bundled within the node implementation.

Troubleshooting

  • Resource Not Found Error: If the specified resource (e.g., "order") is not recognized, ensure the node version supports it and that the resource name is correctly spelled.
  • API Authentication Failures: Verify that the API credentials are correctly set up and have sufficient permissions.
  • Invalid Input Data: Missing required fields like Customer ID or product MPN/quantity will cause errors. Double-check input property values.
  • Unknown Errors: The node captures exceptions and can continue on failure if enabled; otherwise, it throws detailed error messages including stack traces for debugging.

Links and References

  • No external links provided in the source code.
  • For further details, consult the commerce platform's API documentation related to order estimation.

Discussion