Documents

Get document details

Retrieve detailed information about a specific document.

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

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

Path parameters

shipmentIdstring required

Unique shipment identifier

documentIdstring required

Unique document identifier

Response

Document details 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.