Documents

List shipment documents

Retrieve all documents associated with a specific shipment.

get/api/v1/external/shipments/{shipmentId}/documents

Request

Base URL
https://api.wove.com
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.

Path parameters

shipmentIdstring required

Unique shipment identifier

Query parameters

includeDeletedboolean

Include deleted documents in the response

documentTypesstring

Filter by document types (comma-separated)

status'uploaded' | 'processing' | 'completed' | 'failed'

Filter by document status

Response

Documents retrieved successfully

successboolean

Example response

{
  "data": [
    {
      "id": "1013737064058920960",
      "entityId": "1014810279825727490",
      "entityType": "shipment",
      "type": "CommercialInvoice",
      "name": "commercial_invoice.pdf",
      "size": 1024000,
      "checksum": "a1b2c3d4e5f6...",
      "isSelected": true,
      "extractionStatus": "completed"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.