{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/ai/document-ai/managing-documents/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Managing Documents

\n

Use the document list and document endpoints to find, organize, correct, and delete documents.

\n

Find documents in Shipwell

\n

The Document AI list shows each document's filename, type, associations, status, and latest processing information.

\n

Use filters to narrow the list, then open a document to view its metadata, run history, and latest results.

\n

\"Filtering

\n

List documents through the API

\n\n
\n
\n curlpython\n
\n
\n
\n
" \\\\\n --data-urlencode "status=completed" \\\\\n --data-urlencode "entity_type=shipment" \\\\\n --data-urlencode "entity_id=SW-1001" \\\\\n --data-urlencode "sort_by=created_at" \\\\\n --data-urlencode "sort_direction=desc"`, `18359449336672463000`)\"\n >\n
Copy
\n
Copied
\n
\n 
curl --get \\\n  "https://sandbox-api.shipwell.com/document-store/documents" \\\n  -H "Authorization: Token <user-token>" \\\n  --data-urlencode "status=completed" \\\n  --data-urlencode "entity_type=shipment" \\\n  --data-urlencode "entity_id=SW-1001" \\\n  --data-urlencode "sort_by=created_at" \\\n  --data-urlencode "sort_direction=desc"
\n
\n
"},\n params={\n "status": "completed",\n "entity_type": "shipment",\n "entity_id": "SW-1001",\n "sort_by": "created_at",\n "sort_direction": "desc",\n },\n timeout=30,\n)\nresponse.raise_for_status()\ndocuments = response.json()`, `56754043441000950000`)\"\n >\n
Copy
\n
Copied
\n
\n 
import requests\n\nresponse = requests.get(\n    \"https://sandbox-api.shipwell.com/document-store/documents\",\n    headers={\"Authorization\": \"Token <user-token>\"},\n    params={\n        \"status\": \"completed\",\n        \"entity_type\": \"shipment\",\n        \"entity_id\": \"SW-1001\",\n        \"sort_by\": \"created_at\",\n        \"sort_direction\": \"desc\",\n    },\n    timeout=30,\n)\nresponse.raise_for_status()\ndocuments = response.json()
\n
\n
\n \n

Available filters include:

\n\n

Repeat list filters such as status to include multiple values.

\n

Sorting supports filename, created_at, status, and content_type. Results default to 20 per page and support up to 100.

\n

Retrieve one document

\n

Use GET /document-store/documents/{id} to retrieve one document.

\n

The response includes:

\n\n

Update description and associations

\n

PATCH /documents/{id} is a partial update. Provide only the fields that should change.

\n\n
\n
\n curlpython\n
\n
\n
\n
" \\\\\n -H "Authorization: Token " \\\\\n -H "Content-Type: application/json" \\\\\n -d '{\n "description": "Signed proof of delivery for shipment SW-1001",\n "associations": [\n {"entity_type": "shipment", "entity_id": "SW-1001"}\n ]\n }'`, `49668595261170290000`)\"\n >\n
Copy
\n
Copied
\n
\n 
curl -X PATCH \\\n  "https://sandbox-api.shipwell.com/document-store/documents/<document-id>" \\\n  -H "Authorization: Token <user-token>" \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "description": "Signed proof of delivery for shipment SW-1001",\n    "associations": [\n      {"entity_type": "shipment", "entity_id": "SW-1001"}\n    ]\n  }'
\n
\n
",\n headers={"Authorization": "Token "},\n json={\n "description": "Signed proof of delivery for shipment SW-1001",\n "associations": [\n {"entity_type": "shipment", "entity_id": "SW-1001"}\n ],\n },\n timeout=30,\n)\nresponse.raise_for_status()\ndocument = response.json()`, `55389635433819320000`)\"\n >\n
Copy
\n
Copied
\n
\n 
import requests\n\nresponse = requests.patch(\n    \"https://sandbox-api.shipwell.com/document-store/documents/<document-id>\",\n    headers={\"Authorization\": \"Token <user-token>\"},\n    json={\n        \"description\": \"Signed proof of delivery for shipment SW-1001\",\n        \"associations\": [\n            {\"entity_type\": \"shipment\", \"entity_id\": \"SW-1001\"}\n        ],\n    },\n    timeout=30,\n)\nresponse.raise_for_status()\ndocument = response.json()
\n
\n
\n \n

The associations array replaces the complete current array. Send [] to clear all associations.

\n

Correct an extracted value

\n

Human corrections can be added to the latest result:

\n

Send schema_corrections in PATCH /document-store/documents/{id}.

\n

A correction supports:

\n\n

Corrections require an existing result. The endpoint returns no_result when the document has not produced one.

\n

Validate corrected values in the same way as automatically extracted values.

\n\n

List observed document types

\n

Retrieve document types found in your company's latest completed results:

\n

Use GET /document-store/documents/document-types.

\n

Use this list to populate a document-type filter without hardcoding values.

\n

Delete a document

\n

Use DELETE /document-store/documents/{id}. A successful request returns 204 No Content.

\n

Deletion removes the document from customer-facing list, retrieval, search, and inspection operations. Treat deletion as irreversible from your integration's perspective.

","headings":[{"value":"Managing Documents","depth":1},{"value":"Find documents in Shipwell","depth":2},{"value":"List documents through the API","depth":2},{"value":"Retrieve one document","depth":2},{"value":"Update description and associations","depth":2},{"value":"Correct an extracted value","depth":2},{"value":"List observed document types","depth":2},{"value":"Delete a document","depth":2}]},"contentItem":{"data":{"lastModified":"2026-07-17T16:00:10.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"b0f6d4c6-1859-514d-bb9a-f5593c87fa16__redocly content/docs/ai/document-ai/managing-documents/","seo":{"title":"Managing Documents","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/managing-documents.md","pageBaseUrl":"/docs/ai/document-ai/managing-documents","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Managing Documents","id":"managing-documents"},{"depth":2,"value":"Find documents in Shipwell","id":"find-documents-in-shipwell"},{"depth":2,"value":"List documents through the API","id":"list-documents-through-the-api"},{"depth":2,"value":"Retrieve one document","id":"retrieve-one-document"},{"depth":2,"value":"Update description and associations","id":"update-description-and-associations"},{"depth":2,"value":"Correct an extracted value","id":"correct-an-extracted-value"},{"depth":2,"value":"List observed document types","id":"list-observed-document-types"},{"depth":2,"value":"Delete a document","id":"delete-a-document"}]},"data":{"title":"Managing Documents"},"catalogInfo":null,"link":"/docs/ai/document-ai/managing-documents/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}