Tradeshift

Tradeshift Dx Category Documents Document API

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

GitHub OpenAPI

Operations 34

GET /rest/external/documents find documents #
GET /rest/external/documents/companies/{owningCompanyId}/{documentId} Get company document #
GET /rest/external/documents/csv find documents (CSV support) #
POST /rest/external/documents/dispatcher send document #
GET /rest/external/documents/dispatches Get Latest Dispatches #
GET /rest/external/documents/netAmount get document net amount #
PUT /rest/external/documents/received/{documentId} Receive document #
POST /rest/external/documents/validate validate a document #
GET /rest/external/documents/{documentId} find document #
PUT /rest/external/documents/{documentId} update document #
DELETE /rest/external/documents/{documentId} delete document #
DELETE /rest/external/documents/{documentId}/content remove document content #
GET /rest/external/documents/{documentId}/convert convert a document #
GET /rest/external/documents/{documentId}/dispatches/first Get First Dispatch #
GET /rest/external/documents/{documentId}/dispatches/latest Get Latest Dispatch #
PUT /rest/external/documents/{documentId}/dispatches/{dispatchId} Dispatch a saved document #
PUT /rest/external/documents/{documentId}/dispatches/{dispatchId}/scanIOReject Dispatch a saved document rejected by Scan IO validation #
PUT /rest/external/documents/{documentId}/lockedstate/{state} lock a draft document #
GET /rest/external/documents/{documentId}/metadata find document metadata #
GET /rest/external/documents/{documentId}/original Get original content of existing documents within platform #
POST /rest/external/documents/{documentId}/original Asynchronously import a document as a DRAFT #
GET /rest/external/documents/{documentId}/original/responses/{responseId} get document import request response #
GET /rest/external/documents/{documentId}/properties Get document properties #
GET /rest/external/documents/{documentId}/properties/{property_key} Get document property #
PUT /rest/external/documents/{documentId}/properties/{property_key} Add document property #
DELETE /rest/external/documents/{documentId}/properties/{property_key} Delete document property #
GET /rest/external/documents/{documentId}/receivercompany Get document's receiver company #
GET /rest/external/documents/{documentId}/senderReferenceId Get document's referenced id #
GET /rest/external/documents/{documentId}/sendercompany Get document's sender company #
PUT /rest/external/documents/{documentId}/statechange change document state #
GET /rest/external/documents/{documentId}/tags get document tags #
PUT /rest/external/documents/{documentId}/tags/{tag} add document tag #
DELETE /rest/external/documents/{documentId}/tags/{tag} delete document tag #
GET /rest/external/status-change-reasons get status change reasons #

Documentation

📖
Documentation
https://developers.tradeshift.com/docs/api
📖
APIReference
https://developers.tradeshift.com/docs/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/authentication/tradeshift-authentication.yml
📖
GettingStarted
https://developers.tradeshift.com/docs/guides/get-started
📖
Documentation
https://tradeshift.com/resources/ai/tradeshift-mcp-server-amazon-quick-agentic-ai-accounts-payable/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/openapi/tradeshift-dx-category-documents-document-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/json-schema/_index.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/conventions/tradeshift-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/errors/tradeshift-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/data-model/tradeshift-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/asyncapi/tradeshift-webhooks.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/sandbox/tradeshift-sandbox.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/mcp/tradeshift-tool-crosswalk.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/scopes/tradeshift-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tradeshift-dx-category-documents-document-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tradeshift-dx-category-documents-document-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tradeshift External Dx Category Documents Document API
  version: 1.0.0
servers:
- url: https://api.tradeshift.com/tradeshift
tags:


# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tradeshift/refs/heads/main/openapi/tradeshift-dx-category-documents-document-api-openapi.yml