Leanios icon

Leanios

Actions24

Overview

This node integrates with the Leanios API to manage various resources, including Orders. Specifically, for the Order resource with the PATCH operation, it allows updating an existing order by sending a JSON body with the desired changes. This is useful in scenarios where you need to modify order details such as status, quantities, or other attributes after the order has been created.

Practical examples include:

  • Updating the shipping address of an existing order.
  • Changing the order status from "pending" to "completed".
  • Modifying product quantities within an order.

Properties

Name Meaning
Subdomain The Leanios account subdomain to target (e.g., your company or environment identifier).
Request Mode The mode of request payload; for PATCH on Order, only "jsonBody" is supported.
jsonBody The JSON object containing the fields and values to update in the order.
reference (Not used for PATCH operation in this context)

Output

The node outputs a JSON array containing the response from the Leanios API after the PATCH request. This typically includes the updated order object reflecting the changes made.

If the API supports binary data output, it is not handled or indicated in this node's implementation.

Dependencies

  • Requires an active Leanios API credential with username and password for authentication.
  • Needs the Subdomain property to construct the correct API endpoint URL.
  • Uses the Leanios REST API v1 endpoints.

Troubleshooting

  • Common issues:

    • Incorrect or missing Subdomain will cause the API request to fail due to invalid URL.
    • Invalid or expired API credentials will result in authentication errors.
    • Malformed JSON in jsonBody can cause the API to reject the request.
    • Missing required fields in the JSON body may lead to validation errors from the API.

  • Error messages:

    • Errors thrown by the node will contain the message returned by the Leanios API.
    • Authentication failures typically indicate invalid credentials.
    • HTTP 404 errors may indicate that the specified order ID does not exist.

To resolve these:

  • Verify the Subdomain is correct.
  • Check and update API credentials if necessary.
  • Ensure the JSON body is well-formed and contains valid fields.
  • Confirm the order ID exists before attempting to patch.

Links and References

Discussion