Sign in
latestOpenAPI 3.0.12026-08-2091238714.3 KB

d7195c30b6b1

Orders

Get order batch job status

The endpoint returns the state of a batch job and the outcome of every order in it.

While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.

get/v1/orders/batch/{id}/

Response

idstring

Batch job ID. Use it to poll the job status.

status'pending' | 'completed' | 'failed'

pending while orders are still being created, then completed once every order has an outcome, or failed if the whole job could not run.

order_countinteger

Number of orders submitted in the request.

created_countinteger

Number of orders that are usable, counting both created and existing.

failed_countinteger

Number of orders that could not be created.

created_atstring date-time

Time the batch was accepted.

updated_atstring date-time

Time the batch was last updated.

Example response

{
  "id": "9f2c1b7e4a3d4e8fa1b2c3d4e5f60718",
  "status": "completed",
  "order_count": 3,
  "created_count": 2,
  "failed_count": 1,
  "results": [
    {
      "status": "created",
      "order_id": "39aa1486ccca4bc19cda071ffc1ba392",
      "order_number": "CASE-001",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "share_url": "https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "errors": {
        "last_name": [
          "This field is required."
        ]
      }
    }
  ],
  "errors": [
    {
      "detail": [
        "The batch could not be processed."
      ]
    }
  ],
  "created_at": "2026-08-10T09:14:22.881Z",
  "updated_at": "2026-08-10T09:15:04.203Z"
}