SmaxAi icon

SmaxAi

Interact with SmaxAi API

Order → Update Order

AI-generated

Overview

This node updates an existing order in the SmaxAi system. It is useful for scenarios where order details need to be modified after creation, such as updating shipment status, payment information, discounts, or customer details associated with the order. For example, a user can update the status of an order to 'shipped' or adjust the total amount paid after a partial payment.

Use Case Examples

  1. Updating the shipment status of an order to 'shipped'.
  2. Modifying the total surcharge or discount applied to an order.
  3. Changing customer details or cart information within an order.

Properties

Name Meaning
Order ID The unique identifier of the order to be updated.
Order Data A JSON object containing the updated order details, including shipment status, payment amounts, discounts, cart details, and customer information.

Output

JSON

  • json - The updated order data returned from the SmaxAi API after the update operation.

Dependencies

  • Requires an API key credential for SmaxAi API authentication.

Troubleshooting

  • Ensure the Order ID provided is correct and exists in the SmaxAi system to avoid 'order not found' errors.
  • Validate the JSON structure of the Order Data to match the expected schema to prevent request failures.
  • Check API credentials and permissions if authentication errors occur.

Discussion