How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tradeshift Dx Category Documents Document API

The dx-category--documents-document API from Tradeshift — 28 operation(s) for dx-category--documents-document.

Tradeshift Dx Category Documents Document API is one of 38 APIs that Tradeshift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include dx-category–documents-document. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 34 operations across 28 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.tradeshift.com/tradeshift.

34 operations 28 paths 0 schemas 4 DELETE19 GET3 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.tradeshift.com/tradeshift
Resource Areas
1

Paths & Operations 34

Across 28 paths, the API surfaces 34 operations — 4 DELETE, 19 GET, 3 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

dx-category--documents-document 34
GET
/rest/external/documents
find documents
get-rest-external-documents 48 params → 200400406
GET
/rest/external/documents/companies/{owningCompanyId}/{documentId}
Get company document
get-rest-external-documents-companies-owningcompanyid-documentid 3 params → 307404
GET
/rest/external/documents/csv
find documents (CSV support)
get-rest-external-documents-csv 38 params → 200400406
POST
/rest/external/documents/dispatcher
send document
post-rest-external-documents-dispatcher 3 params body → 201400
GET
/rest/external/documents/dispatches
Get Latest Dispatches
get-rest-external-documents-dispatches 3 params → 200
GET
/rest/external/documents/netAmount
get document net amount
get-rest-external-documents-netamount 2 params → 200404
PUT
/rest/external/documents/received/{documentId}
Receive document
put-rest-external-documents-received-documentid 2 params body → 204400
POST
/rest/external/documents/validate
validate a document
post-rest-external-documents-validate 4 params body → 204400412
GET
/rest/external/documents/{documentId}
find document
get-rest-external-documents-documentid 3 params → 200400401404
PUT
/rest/external/documents/{documentId}
update document
put-rest-external-documents-documentid 6 params body → 204400
DELETE
/rest/external/documents/{documentId}
delete document
delete-rest-external-documents-documentid 1 param → 204401404
DELETE
/rest/external/documents/{documentId}/content
remove document content
delete-rest-external-documents-documentid-content 1 param → 204401
GET
/rest/external/documents/{documentId}/convert
convert a document
get-rest-external-documents-documentid-convert 6 params → 200401404
GET
/rest/external/documents/{documentId}/dispatches/first
Get First Dispatch
get-rest-external-documents-documentid-dispatches-first 2 params → 200404
GET
/rest/external/documents/{documentId}/dispatches/latest
Get Latest Dispatch
get-rest-external-documents-documentid-dispatches-latest 2 params → 200404
PUT
/rest/external/documents/{documentId}/dispatches/{dispatchId}
Dispatch a saved document
put-rest-external-documents-documentid-dispatches-dispatchid 4 params body → 201400404503
PUT
/rest/external/documents/{documentId}/dispatches/{dispatchId}/scanIOReject
Dispatch a saved document rejected by Scan IO validation
put-rest-external-documents-documentid-dispatches-dispatchid-scanioreject 3 params body → 201400404503
PUT
/rest/external/documents/{documentId}/lockedstate/{state}
lock a draft document
put-rest-external-documents-documentid-lockedstate-state 2 params → 204
GET
/rest/external/documents/{documentId}/metadata
find document metadata
get-rest-external-documents-documentid-metadata 1 param → 200
GET
/rest/external/documents/{documentId}/original
Get original content of existing documents within platform
get-rest-external-documents-documentid-original 2 params → 200400
POST
/rest/external/documents/{documentId}/original
Asynchronously import a document as a DRAFT
post-rest-external-documents-documentid-original 5 params body → 202400
GET
/rest/external/documents/{documentId}/original/responses/{responseId}
get document import request response
get-rest-external-documents-documentid-original-responses-responseid 3 params → 201202400401404500
GET
/rest/external/documents/{documentId}/properties
Get document properties
get-rest-external-documents-documentid-properties 2 params → 200401
GET
/rest/external/documents/{documentId}/properties/{property_key}
Get document property
get-rest-external-documents-documentid-properties-property_key 3 params → 200204401
PUT
/rest/external/documents/{documentId}/properties/{property_key}
Add document property
put-rest-external-documents-documentid-properties-property_key 3 params body → 201401
DELETE
/rest/external/documents/{documentId}/properties/{property_key}
Delete document property
delete-rest-external-documents-documentid-properties-property_key 2 params → 200401
GET
/rest/external/documents/{documentId}/receivercompany
Get document's receiver company
get-rest-external-documents-documentid-receivercompany 2 params → 200204404
GET
/rest/external/documents/{documentId}/senderReferenceId
Get document's referenced id
get-rest-external-documents-documentid-senderreferenceid 2 params → 200404
GET
/rest/external/documents/{documentId}/sendercompany
Get document's sender company
get-rest-external-documents-documentid-sendercompany 2 params → 200204404
PUT
/rest/external/documents/{documentId}/statechange
change document state
put-rest-external-documents-documentid-statechange 2 params body → 204400401
GET
/rest/external/documents/{documentId}/tags
get document tags
get-rest-external-documents-documentid-tags 2 params → 200
PUT
/rest/external/documents/{documentId}/tags/{tag}
add document tag
put-rest-external-documents-documentid-tags-tag 2 params → 201
DELETE
/rest/external/documents/{documentId}/tags/{tag}
delete document tag
delete-rest-external-documents-documentid-tags-tag 2 params → 200
GET
/rest/external/status-change-reasons
get status change reasons
get-rest-external-status-change-reasons → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tradeshift-dx-category-documents-document-api-openapi.yml Raw ↑

Other APIs Tradeshift publishes across the network.

Tradeshift Admin API
Tradeshift Document Validation API
Tradeshift Dx Category Accounts Branches API
Tradeshift Dx Category Accounts Company API
Tradeshift Dx Category Accounts Gli Prefixes API
Tradeshift Dx Category Accounts Legal Entities API
Tradeshift Dx Category Accounts Taxes API
Tradeshift Dx Category Accounts Validations API
Tradeshift Dx Category Assignments Create API
Tradeshift Dx Category Assignments Find API
Tradeshift Dx Category Assignments Logs API
Tradeshift Dx Category Assignments Reassign API
Where this information came from

This is an independent, third-party profile of Tradeshift Dx Category Documents Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.