CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Actions16

Overview

This node interacts with a cloud commerce API to perform various operations on different resources, including plans. Specifically, the "Get Many" operation for the Plan resource retrieves multiple plan records from the service. This is useful when you want to fetch a list of available plans, for example, to display them in a dashboard, synchronize them with another system, or analyze pricing options.

Typical use cases include:

  • Retrieving all subscription plans available in an account.
  • Fetching a limited number of plans for quick previews or summaries.
  • Integrating plan data into reporting or billing workflows.

Properties

Name Meaning
Return All Whether to return all available plan results or only up to a specified limit.
Limit The maximum number of plan results to return (only applicable if "Return All" is false).

Output

The output is an array of JSON objects, each representing a single plan retrieved from the API. Each item contains the full details of a plan as returned by the external service.

  • When "Return All" is true, the node returns all matching plans.
  • When "Return All" is false, it returns up to the number specified by "Limit".
  • The output does not include binary data; it is purely JSON structured data describing plans.

Example output structure (simplified):

[
  {
    "json": {
      "id": "plan_123",
      "name": "Basic Plan",
      "description": "Entry-level subscription plan",
      "price": 9.99,
      "currency": "USD",
      ...
    }
  },
  {
    "json": {
      "id": "plan_456",
      "name": "Pro Plan",
      "description": "Advanced features included",
      "price": 29.99,
      "currency": "USD",
      ...
    }
  }
]

Dependencies

  • Requires an initialized API service client configured with appropriate credentials (e.g., an API key or authentication token).
  • Depends on the external cloud commerce platform's API being accessible and responsive.
  • No additional environment variables are explicitly required beyond standard API credential configuration.

Troubleshooting

  • Resource Not Found Error: If the node throws an error stating the resource is not found or not migrated, verify that the resource name ("plan") is correctly spelled and supported by the current version of the node.
  • API Authentication Errors: Ensure that the API credentials are valid and have sufficient permissions to read plan data.
  • Rate Limits or Timeouts: If retrieving many plans, consider enabling "Return All" carefully to avoid hitting API rate limits or timeouts.
  • Partial Failures: If some items fail during execution but "Continue On Fail" is enabled, errors will be included in the output JSON under an error field for those items.

Links and References

  • Refer to your cloud commerce platform’s official API documentation for detailed schema and capabilities of the Plan resource.
  • n8n documentation on creating custom nodes for further customization guidance.

Discussion