Fetch route action status

This endpoint allows you to check the status of a previously triggered route-publishing action for a specific workspace and date.
It returns both high-level metadata about the action and granular information about the status of publishing each of the individual routes for the day.

Request URL

get https://api.plan.routific.com/v2/routes/actions/{actionUuid}

Request Payload

//none

Response Payload

A successful response contains metadata describing the action as well as detailed publish results for each route.

{
  "actionUuid": "b6efdf4f-5272-4ca5-9066-fe13fd0d96d4",
  "actionName": "publish",
  "error": "One or more of routes failed to publish",
  "actionSummary": {
    "routes": [
      {
        "uuid": "be7be486-52ae-4b92-a2db-b7fac9fa885c",
        "actionStatus": "finished"
      },
      {
        "uuid": "c44dc101-48c4-420b-abda-fc30b29be014",
        "actionStatus": "finished"
      },
      {
        "uuid": "d44dc101-48c4-420b-abda-fc30b29ba712",
        "error": "route doesn't exist",
        "actionStatus": "failed"
      }
    ]
  },
  "status": "failed"
}

📘
Status of Publishing Routes
The status field can resemble any one of these values: pending, finished, failed. The status field is an indicator of overall state of publishing routes for a given day. If action fails to publish atleast 1 route for the day, the status field will set to failed, even if other routes have been successfully published.

📘
Which routes get published?

Routes with no orders are skipped. There is nothing to dispatch.

Already-published routes with no changes are skipped. Re-sending an unchanged route would notify the driver for no reason.

Already-published routes that have changed are re-sent. Routific driver app marks the route as Updated.

If no route qualifies, the request returns 400 PUBLISH_FAILED. This means there was nothing to publish.

DATA fields

Field	Type	Description
actionUuuid	String	Unique identifier of the action.
actionName	String	Name of the action being performed.
error	String	If status is failed, the error message will indicate the type of failure.
actionSummary	Object	Summary of publishing routes action
actionSummary.routes	Array	Array of routes that were attempted to publish
actionSummary.routes.uuid	String	Route's uuid
actionSummary.routes.actionStatus	String	Route's publishing status
actionSummary.routes.error	String	Detailed error message for failure to publish a route
status	Integer	Current status of the action. Possible values: pending, finished, and failed.

❗️
Failed Status
The action will be marked asfailed if any individual route fails. You must inspect actionSummary for detailed per-route outcomes.