CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Overview

This node is designed to update subscription details in a cloud commerce platform. It allows users to modify specific fields of an existing subscription, such as its renewal status, custom attributes, and associated products with pricing information. This functionality is useful for scenarios where subscription terms need adjustment after creation, for example, enabling or disabling auto-renewal, updating metadata attributes, or changing product configurations and prices within the subscription.

Practical examples include:

  • Turning off auto-renewal for a subscription that a customer no longer wants to continue.
  • Adding or modifying custom attributes to track additional subscription metadata.
  • Updating product details like unit price or adding/removing products from the subscription.

Properties

Name Meaning
Subscription ID The unique identifier of the subscription to update.
Update Fields A collection of fields to update on the subscription:
- Renewal Status Boolean flag indicating whether the subscription should auto-renew (true = auto-renew enabled).
- Attributes Multiple key-value pairs representing custom attributes to add or update on the subscription.
- Products Multiple products to associate with the subscription, each including:
• MPN (Manufacturer Part Number)
• Product ID
• Unit Price details:
- Currency code (e.g., USD)
- Amount (price value)

Output

The node outputs JSON data representing the updated subscription object returned by the API after applying the changes. This typically includes the current state of the subscription with all updated fields reflected.

If multiple items are processed, the output is an array of such JSON objects, one per input item.

No binary data output is indicated in the source code.

Dependencies

  • Requires an initialized API service client configured with appropriate credentials (such as an API key or authentication token) to communicate with the cloud commerce platform.
  • The node depends on a resource registry system internally to resolve and execute operations on the "subscription" resource.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Resource Not Found Error: If the specified resource ("subscription") is not recognized or migrated, the node will throw an error. Ensure the resource name is correct and supported by the node version.
  • Unexpected Errors: Generic errors during execution may occur if the API service is unreachable, credentials are invalid, or input parameters are malformed.
  • Continue On Fail Behavior: When enabled, the node will continue processing subsequent items even if some fail, returning error messages in the output JSON for failed items.
  • Invalid Input Data: Missing required fields like Subscription ID or empty update fields can cause failures. Validate inputs before running the node.

Links and References

  • No direct external links are provided in the source code.
  • For more information, consult the cloud commerce platform's API documentation related to subscription management.
  • Refer to n8n documentation on creating and configuring API credential types and using fixed collections for complex input structures.

Discussion