CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Actions16

Order → Get Many

AI-generated

Overview

This node operation retrieves multiple orders from the CloudBlue Commerce platform based on specified filters and limits. It is useful for scenarios where users need to fetch a list of orders, such as generating reports, monitoring order statuses, or integrating order data into other systems. For example, a user can fetch all orders with a 'Completed' status created within a specific date range or limit the results to a certain number for pagination purposes.

Use Case Examples

  1. Fetch all orders with status 'Completed' created in the last month.
  2. Retrieve up to 50 orders filtered by a specific customer ID.
  3. Get orders with detail type 'Renew' and status 'Processing'.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return when 'Return All' is false, with a maximum of 500.
Filters Filters to narrow down the orders retrieved, including status, detail type, customer ID, subscription ID, order number, status code, and creation time range.

Output

JSON

  • json
    • ``
      * id - The unique identifier of each order.
      * status - The status of each order.
      * detailType - The detail type of each order.
      * customerId - The ID of the customer who placed the order.
      * subscriptionId - The subscription ID created from the order.
      * orderNumber - The order number.
      * statusCode - The internal status code of the order.
      * creationTime - The creation time of the order.

Dependencies

  • CloudBlue Commerce API service initialized via credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access order data.
  • If the node throws a 'Resource not found' error, verify that the 'Order' resource is supported and correctly spelled in the node configuration.
  • When using filters, ensure the filter values are valid and correctly formatted, especially date filters with preset or custom dates.
  • If the node returns fewer results than expected, check the 'Return All' and 'Limit' settings to ensure they match the desired output size.

Discussion