CloudBlue Commerce SimpleAPI icon

CloudBlue Commerce SimpleAPI

Interact with CloudBlue Commerce SimpleAPI

Order → Update

AI-generated

Overview

This node updates an existing order in the system. It is useful for scenarios where you need to modify order details such as the credit check status or the internal status code of an order. For example, you can update an order to reflect a new status after processing or to enable/disable credit checks for the customer associated with the order.

Use Case Examples

  1. Updating the status code of an order to 'Processed' after payment confirmation.
  2. Enabling credit check for a customer's order before final approval.

Properties

Name Meaning
Order ID The unique identifier of the order to be updated.
Update Data A collection of fields to update on the order, including credit check status and internal status code.

Output

JSON

  • orderId - The ID of the updated order.
  • creditCheck - Indicates if the customer's credit check was applied.
  • statusCode - The updated internal status code of the order.

Dependencies

  • Requires an API service initialized with appropriate credentials to interact with the order resource.

Troubleshooting

  • Common issues include providing an invalid or non-existent Order ID, which will cause the update to fail.
  • Errors may occur if required fields in the update data are missing or incorrectly formatted.
  • If the resource or operation is not found, the node throws an error indicating the resource is not migrated or available.
  • To resolve errors, ensure the Order ID is correct, the update data is valid, and the API credentials are properly configured.

Discussion