CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Actions16

Overview

The node provides functionality to retrieve multiple orders from a commerce system, supporting various filters and pagination controls. It is useful in scenarios where you need to fetch a list of orders for reporting, auditing, or integration with other systems. For example, you might want to get all completed orders within the last month or retrieve orders related to a specific customer or subscription.

Properties

Name Meaning
Return All Whether to return all matching orders or limit the number of results.
Limit Maximum number of orders to return when "Return All" is false. The maximum allowed value is 500.
Filters A collection of filters to narrow down the orders returned:
  Status Filter orders by their status. Options: Submitted, Processing, Error, Completed, Cancelled.
  Detail Type Filter by the type of order detail. Options include Unknown, Setup, Setuprefund, Switch, Renew, Renewrefund, Transfer, Transferrefund, Recurring, Recurringrefund, Overuse, Downgrade, Discount, Adjustment, Cancellation, Handlingfee, Nonprovisioningitem, Payment, Refund, Refundadjustment, Billpenalty, Billrecord, Resellerpayment, Deposit.
  Customer ID Filter orders by the ID of the customer who placed them.
  Subscription ID Filter orders by the subscription ID created from the order.
  Order Number Filter by the specific order number.
  Status Code Filter by internal status code of the order.
  Created After Filter orders created after a certain date/time. Can be specified as a preset relative date (e.g., Today, Yesterday, 1 Week Ago) or a custom exact date/time.
  Created Before Filter orders created before a certain date/time. Similar options as "Created After".

Output

The output is an array of JSON objects, each representing an order that matches the specified filters and limits. Each JSON object contains the full details of an order as returned by the underlying API. The node does not explicitly handle binary data output.

Example output structure (simplified):

[
  {
    "json": {
      "orderId": "12345",
      "status": "completed",
      "customerId": "cust-001",
      "subscriptionId": "sub-001",
      "orderNumber": "ORD-20230401-0001",
      "creationTime": "2023-04-01T12:00:00Z",
      "details": [ ... ],
      ...
    }
  },
  ...
]

Dependencies

  • Requires connection to the CloudBlue Commerce API or equivalent backend service.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The node depends on a resource registry and API service initialization utility internally to manage resources and execute operations.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Requesting more than the maximum allowed limit (500) may result in errors.
    • Using unsupported filter values or malformed dates can cause the API to reject the request.
  • Error messages:
    • Errors are caught and reported per item unless "Continue On Fail" is enabled.
    • Typical error messages include authentication errors, invalid parameter errors, or network connectivity issues.
  • Resolution tips:
    • Verify API credentials and permissions.
    • Ensure filter values conform to allowed options.
    • Use valid date formats or presets for date filters.
    • Enable "Continue On Fail" to allow partial processing when some items fail.

Links and References

  • No direct external links provided in the source code.
  • For more information, consult the CloudBlue Commerce API documentation or your platform's API reference for order retrieval endpoints.

Discussion