Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wove Documents API

Document management within shipments

Wove Documents API is one of 10 APIs that Wove publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 21 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.wove.com, https://staging-api.wove.com, http://localhost:4000.

27 operations 21 paths 6 schemas 2 DELETE12 GET10 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.wove.com
https://staging-api.wove.com
http://localhost:4000
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wove Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from /auth/token endpoint

Paths & Operations 27

Across 21 paths, the API surfaces 27 operations — 2 DELETE, 12 GET, 10 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 27

Document management within shipments

GET
/api/v1/external/shipments/{shipmentId}/documents
List shipment documents
4 params → 200
POST
/api/v1/external/shipments/{shipmentId}/documents
Upload document
1 param body → 201
GET
/api/v1/external/shipments/{shipmentId}/documents/{documentId}
Get document details
2 params → 200404
PUT
/api/v1/external/shipments/{shipmentId}/documents/{documentId}
Update document
2 params body → 200
DELETE
/api/v1/external/shipments/{shipmentId}/documents/{documentId}
Delete document
2 params → 204404
GET
/api/v1/external/shipments/{shipmentId}/documents/{documentId}/download
Download document
2 params → 200404
GET
/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extraction
Get extraction status
2 params → 200
POST
/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extract
Start extraction
2 params body → 200
PUT
/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extracted-data
Update extracted data
2 params body → 200
GET
/api/v1/external/shipments/{shipmentId}/documents/{documentId}/history
Get document history
2 params → 200
POST
/api/v1/external/shipments/{shipmentId}/documents/validate
Validate documents
1 param body → 200
GET
/api/v1/external/shipments/{shipmentId}/documents/cross-validate/{jobId}
Get cross-validation job status
2 params → 200404
GET
/api/v1/external/shipments/{shipmentId}/documents/merge/{jobId}
Get merge job status
2 params → 200404
POST
/api/v1/external/shipments/{shipmentId}/documents/cross-validate
Cross-validate documents
1 param body → 200400404
POST
/api/v1/external/shipments/{shipmentId}/documents/merge
Merge shipment documents
1 param body → 200400404
POST
/api/v1/external/shipments/{shipmentId}/documents/analyze-types
Analyze document types
1 param body → 200400404413
POST
/api/v1/external/shipments/{shipmentId}/documents/upload-multi
Upload multi-document file
1 param body → 200400404413
GET
/api/v1/external/entities/{entityType}/{entityId}/documents
List entity documents
5 params → 200404
POST
/api/v1/external/entities/{entityType}/{entityId}/documents
Upload document to entity
2 params body → 201400404
POST
/api/v1/external/entities/{entityType}/{entityId}/documents/multi
Upload multi-document PDF
2 params body → 201400404
GET
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}
Get document details
3 params → 200404
PUT
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}
Update document metadata
3 params body → 200404
DELETE
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}
Delete document
3 params → 204404
GET
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}/download
Download document
3 params → 200404
GET
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}/preview
Get document preview URL
4 params → 200404
GET
/api/v1/external/entities/{entityType}/{entityId}/documents/{documentId}/history
Get document history
3 params → 200404
POST
/api/v1/external/documents/guess-type
Guess document type
body → 200400401403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Document (14 properties), DocumentHistoryEntry (4 properties), MergeJobResponse (4 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

MergeDocumentsRequest
object
1 property 1 required
ValidateDocumentsRequest
object
1 property 1 required
Document
object
14 properties
MergeJobResponse
object
4 properties
ErrorResponse
object
2 properties 2 required
DocumentHistoryEntry
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wove-documents-api-openapi.yml Raw ↑

Other APIs Wove publishes across the network.

Wove Authentication API
Wove Query Bank API
Wove Rates API
Wove Shipments API
Wove Sources API
Wove Tariffs API
Wove Testing API
Wove TMS Organizations API
Wove Webhooks API