Documents

Start extraction

Start or restart extraction for a document.

post/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extract

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/:documentId/extract/post.ts
A function with typed inputs. Its response is checked against the schema.

shipmentIdstring required

Unique shipment identifier

documentIdstring required

Unique document identifier

reprocessboolean

Force reprocessing even if already extracted

fieldsstring[]

Specific fields to extract

Extraction started successfully

successboolean

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