latestOpenAPI 3.1.02026-08-1413100188.4 KB

7810ddb35640

Orders

updateActionStatus - Update asynchronous action status

<div class="extension-title">Description</div>

Updates the final status of an asynchronous action previously initiated through a command event.

Overview

  • When an asynchronous action is requested via command event, an action_id is provided to track the action
  • Use this endpoint to report the final outcome (SUCCESS or FAILURE) of the action
  • For failed actions, detailed error information must be provided

Usage Notes

  • Update should be sent once the action is fully completed
  • Multiple errors can be provided for failed actions
  • The action ID must match the one provided in the original command event
<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: Send update as soon as the action is completed</div> <div class="max-call-frequency">Maximum usage: Once per action completion</div> </div>
put/v1/orders/actions/{action_id}

Path parameters

action_idstring required

The unique identifier of the action. This ID was provided in the original command event that initiated the action.

Request body

statusstring required

The final status of the asynchronous action:

  • SUCCESS - The action completed successfully with no errors
  • FAILED - The action encountered errors and could not be completed (requires error details in the errors array)

Enum: "SUCCESS", "FAILED"

Example request

{
  "errors": [
    {
      "message": "Cannot process cancellation: order is already shipped"
    }
  ]
}

Response

The action status was successfully updated. No additional content is provided.