Documents

Upload document

Upload a single document to a shipment.

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

Path parameters

shipmentIdstring required

Unique shipment identifier

Request body multipart/form-data

filestring binary required

File to upload

documentTypestring

Document type

Example request

{
  "documentType": "CommercialInvoice"
}

Response

Document uploaded successfully

successboolean

messagestring

Example response

{
  "data": {
    "id": "1013737064058920960",
    "entityId": "1014810279825727490",
    "entityType": "shipment",
    "type": "CommercialInvoice",
    "name": "commercial_invoice.pdf",
    "size": 1024000,
    "checksum": "a1b2c3d4e5f6...",
    "isSelected": true,
    "extractionStatus": "completed"
  },
  "message": "Document uploaded successfully and extraction queued"
}

Changes

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