TradeWindow Partner API used for integration of systems to support the creation and progression of trade contracts through the TradeWindow platform.
Access to this service is authenticated and not for public use.
Servers
Receive shipment related notification from partner system.
/v2.0/contract_events
2.Body Example
{
"contract_id": "4899b036-6e2c-4112-9e67-5f0a4eeb9455",
"occurrence_time": "2018-12-19T01:15:11.032Z",
"meta": {
"status": "event messages (status)"
}
}
This API will return all the Organisations within TradeWindow with a GUID idetifier which can be used to idetify Organisations in other APIs
/v2.0/organisations
2.Body Example
Query Parameters :
- business_name[{operator_name}]={keyword}
- issuing_body.name[{operator_name}]={keyword}
- issuing_body.code[{operator_name}]={keyword}
This API will return summary of all the document lists associated with this contract
/v2.0/contracts
2.Body Example
Query Parameters :
- issuing_body.name[{operator_name}]={keyword}
- issuing_body.code[{operator_name}]={keyword}
Upload New Document to a contract, supporting files as well as meta information a digital representation of the document.
/v2.0/documents
2.Body Example
{
"contract_id": "c3b0aae6-133e-4c28-9e7b-ccc0e4aaec3d",
"document_type_id": "3f56444a-699d-488d-b369-224261b0b147",
"metadata": {
"mime": "application/pdf",
"size": 8210,
"file_name": "Commercial Invoice"
},
"summary": {
"title": "title",
"keyword": "#Open Account, #Company Name",
"category": "Contract Document",
"organisation_id": "1f4502e5-3b3c-456d-b062-5107268382d0"
},
"file": "string"
}