MImirakl
Orders

v2-getActionStatus - Track an asynchronous action request

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

Use this API to check the status of an asynchronous action request (e.g., v2-acceptOrderLines) and retrieve any potential errors that occurred during the action processing. We recommend integrating this API asynchronously.

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: Asynchronous: every 5 minutes per action ID</div> <div class="max-call-frequency">Maximum usage: Asynchronous: once per minute per action ID</div> </div>
get/v2/orders/actions/{action_id}

Request

Path parameters

action_idstring required

The unique identifier that is returned when an asynchronous action (e.g., v2-acceptOrderLines) is requested.

Response

Details of the action, including current status and potential errors

created_atstring date-time required

Action creation date

idstring required

The unique identifier for the asynchronous action. This ID is generated when the action is initially requested.

status'PENDING' | 'SUCCESS' | 'FAILED' required

Current action status

updated_atstring date-time required

Date of last modification of the action status

Example response

{
  "created_at": "2021-07-06T09:24:36.32Z",
  "errors": [
    {
      "code": "ORDER_IN_WRONG_STATE",
      "message": "The order was not in the expected status."
    }
  ],
  "id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "status": "PENDING",
  "updated_at": "2021-07-06T09:24:36.32Z"
}

Changes

  • d12b10bceb6aRevision changes
    • warning

      added the new FAILED enum value to the response property for the response status

    • warning

      added the new PENDING enum value to the response property for the response status

    • warning

      added the new SUCCESS enum value to the response property for the response status