---
title: "List shipment documents"
method: GET
path: "/api/v1/external/shipments/{shipmentId}/documents"
tags: ["Documents"]
---

# List shipment documents

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

## Request

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

Retrieve all documents associated with a specific shipment.

## Path parameters

- `shipmentId` string, required

## Query parameters

- `includeDeleted` boolean
- `documentTypes` string
- `status` 'uploaded' | 'processing' | 'completed' | 'failed'

## Response `200`

Documents retrieved successfully

- object
  - `success` boolean
  - `data` Document[]
    - `id` string
    - `entityId` string
    - `entityType` string
    - `type` string
    - `name` string
    - `size` integer
    - `checksum` string
    - `isSelected` boolean
    - `extractedData` object: Extracted data from the document
    - `extractionStatus` 'pending' | 'processing' | 'completed' | 'failed'
    - `extractionError` string
    - `extractedAt` string, date-time
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

---

[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)