---
title: "Get shipment jobs"
method: GET
path: "/api/v1/external/shipments/{shipmentId}/jobs"
tags: ["Shipments"]
---

# Get shipment jobs

`GET /api/v1/external/shipments/{shipmentId}/jobs`

## Request

- Base URL: `https://api.wove.com`
- URL: `https://api.wove.com/api/v1/external/shipments/{shipmentId}/jobs`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/wove/apis/wove-external-api/docs/api/v1/external/shipments/:shipmentId/jobs/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all background jobs (extraction, validation, merge) for a shipment.

## Path parameters

- `shipmentId` string, required

## Response `200`

Jobs retrieved successfully

- object
  - `success` boolean
  - `data` object
    - `jobs` object
      - `crossValidation` CrossValidationJob[]
        - `id` string
        - `type` 'cross-validation'
        - `status` 'pending' | 'processing' | 'completed' | 'failed'
        - `progress` number: Progress percentage (0-100)
        - `documentIds` string[]
        - `result` object, nullable
          - `validatedFields` string[]
          - `issues` object[]
            - `field` string
            - `message` string
            - `severity` 'critical' | 'warning'
            - `suggestion` string, nullable
            - `files` string[]
            - `documents` string[]
          - `validationResult` object[]
            - `id` string
            - `field` string
            - `files` string[]
            - `reason` string
            - `status` string
            - `suggestion` string, nullable
        - `createdAt` string, date-time
        - `startedAt` string, date-time, nullable
        - `completedAt` string, date-time, nullable
      - `merge` MergeJob[]
        - `id` string
        - `type` 'merge'
        - `status` 'pending' | 'processing' | 'completed' | 'failed'
        - `progress` number: Progress percentage (0-100)
        - `documentIds` string[]
        - `result` unknown
        - `createdAt` string, date-time
        - `startedAt` string, date-time, nullable
        - `completedAt` string, date-time, nullable

## Other responses

- `404`: Shipment not found

---

[API](https://skmtc.dev/wove/apis/wove-external-api.md) - [All operations](https://skmtc.dev/wove/apis/wove-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wove/apis/wove-external-api/revisions/37290e267e07?raw)