Change order status icon

Change order status

Change order status, you can cancel and order using the status CANCELED, rest of available status are PENDING, ACCEPTED, DRIVER_IN_BRANCH, TRANSIT, ONSITE and COMPLETED, needs order ID and status

Change order status

AI-generated

Overview

This node changes the status of an order in a delivery system. It allows users to update the order status to values such as CANCELED, PENDING, ACCEPTED, DRIVER_IN_BRANCH, TRANSIT, ONSITE, and COMPLETED. The node requires the order ID and the new status, and optionally a reason for ending the order. It is useful for managing order workflows and tracking order progress in delivery or logistics applications.

Use Case Examples

  1. Cancel an order by setting status to CANCELED and providing a reason for cancellation.
  2. Update an order status to TRANSIT when the delivery driver is en route.
  3. Mark an order as COMPLETED once the delivery is finished.

Properties

Name Meaning
Order The ID of the order whose status is to be changed.
Status The new status to set for the order. Possible values include CANCELED, PENDING, ACCEPTED, DRIVER_IN_BRANCH, TRANSIT, ONSITE, and COMPLETED.
Ended Reason Optional reason for ending the order, used when the status is CANCELED or similar.

Output

JSON

  • json - The JSON response from the API after updating the order status, containing details about the updated order or error information.

Dependencies

  • An API key credential named 'jelpDeliveryApi' is required for authentication to the delivery API.

Troubleshooting

  • Common issues include invalid or missing order ID, unsupported status values, or authentication failures with the API key.
  • Error messages may include API response errors or network issues. Ensure the order ID and status are correct and the API key credential is valid and has necessary permissions.

Discussion