Menu
/api/purchase_orders/refresh/item/{refNo}/{version} (Partial refresh of vpoItem by vpo refNo and version) (POST)
Partial refresh of vpoItem by vpo refNo and version
POST
/api/purchase_orders/refresh/item/{refNo}/{version}Use it in a workflow
- Add a step and choose the TradeBeyond connector.
- Pick the /api/purchase_orders/refresh/item/{refNo}/{version} (Partial refresh of vpoItem by vpo refNo and version) (POST) action (under VendorPurchaseOrderController).
- Fill in the fields below, then reference the result from later steps as
{{apiPurchaseOrdersRefreshItemRefnoVersionPartialRefreshOfVpoitemByVpoRefnoAndVersionPost.response.data}}.
Request
Path parameters
Response
Returns 200 with an object. Read it in later steps with {{apiPurchaseOrdersRefreshItemRefnoVersionPartialRefreshOfVpoitemByVpoRefnoAndVersionPost.response.data.<field>}}.
{
"data": {
"id": "string",
"refNo": "string",
"version": 0,
"vpoNo": "string",
"shipmentDate": "2025-01-01"
},
"message": "string",
"dialogButtonType": "YESNO",
"alertDialogType": "WARNING",
"messageStatus": "UNRELEASE",
"actionResult": {
"actionResultId": 0,
"originalEntityDto": {
"id": "string",
"version": 0,
"refNo": "string",
"domainId": "string",
"status": "string",
"hubDomainId": "string",
"amIOwner": false,
"partiesList": [
{
"revision": 0,
"entityVersion": 0,
"domainId": "string",
"hubDomainId": "string",
"isForReference": false,
"internalSeqNo": 0,
"duid": "string",
"partyNameSeqNo": 0,
"contactUserSeqNo": 0,
"isOwner": false,
"partyName": {
"code": "string",
"name": "string",
"version": 0
},
"contactUser": {
"id": "string",
"refNo": "string",
"version": 0,
"userName": "string",
"docStatus": "string"
}
}
],
"initializePartyByDocumentId": "string",
"docTagList": [
{
"id": "string",
"refNo": "string",
"revision": 0,
"entityVersion": 0,
"domainId": "string",
"hubDomainId": "string",
"isForReference": false,
"version": 0,
"status": "string",
"docStatus": "string",
"editingStatus": "string",
"amIOwner": false
}
],
"docStatus": "string",
"fromImport": false
},
"mainDto": {
"id": "string",
"version": 0,
"refNo": "string",
"domainId": "string",
"status": "string",
"hubDomainId": "string",
"amIOwner": false,
"partiesList": [
{
"revision": 0,
"entityVersion": 0,
"domainId": "string",
"hubDomainId": "string",
"isForReference": false,
"internalSeqNo": 0,
"duid": "string",
"partyNameSeqNo": 0,
"contactUserSeqNo": 0,
"isOwner": false,
"partyName": {
"code": "string",
"name": "string",
"version": 0
},
"contactUser": {
"id": "string",
"refNo": "string",
"version": 0,
"userName": "string",
"docStatus": "string"
}
}
],
"initializePartyByDocumentId": "string",
"docTagList": [
{
"id": "string",
"refNo": "string",
"revision": 0,
"entityVersion": 0,
"domainId": "string",
"hubDomainId": "string",
"isForReference": false,
"version": 0,
"status": "string",
"docStatus": "string",
"editingStatus": "string",
"amIOwner": false
}
],
"docStatus": "string",
"fromImport": false
},
"tagDtos": [
{
"id": "string",
"fromImport": false,
"deleteCommentFieldInfoList": [
{
"uiId": "string",
"businessKey": "string",
"internalSeqNo": 0
}
],
"get_overrideCreateUser": "string",
"get_overrideCreateUserName": "string",
"get_overrideUpdateUser": "string",
"get_overrideUpdateUserName": "string",
"get_overrideCreatedOn": "2025-01-01T00:00:00Z",
"get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
"get_overrideStatus": "string",
"refNo": "string",
"revision": 0
}
],
"esIndexNeedDtoList": [
{
"module": "NONE",
"refNo": "string",
"version": 0,
"mainEntity": {
"version": 0,
"createActionKey": 0,
"refNo": "string",
"status": "string",
"createUser": "string",
"updatedOn": "2025-01-01T00:00:00Z",
"businessRefNo": "string",
"partiesList": [
{
"partyName": null,
"contactUserId": null,
"contactUserRef": null,
"contactUserVer": null,
"docId": null,
"contactUser": null,
"isOwner": null,
"contactUserSeqNo": null,
"partyNameSeqNo": null,
"uniqueKey": null,
"internalSeqNo": null,
"duid": null
}
],
"docTagList": [
{
"id": null,
"revision": null,
"entityVersion": null,
"domainId": null,
"hubDomainId": null,
"isForReference": null,
"version": null,
"status": null,
"docStatus": null,
"editingStatus": null,
"createUser": null,
"createUserName": null
}
],
"docStatus": "string",
"get_overrideCreateUser": "string",
"get_overrideCreateUserName": "string"
},
"tags": [
{
"id": "string",
"fromImport": false,
"deleteCommentFieldInfoList": [
null
],
"get_overrideCreateUser": "string",
"get_overrideCreateUserName": "string",
"get_overrideUpdateUser": "string",
"get_overrideUpdateUserName": "string",
"get_overrideCreatedOn": "2025-01-01T00:00:00Z",
"get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
"get_overrideStatus": "string",
"refNo": "string",
"revision": 0
}
],
"delete": false
}
],
"otherIndexContextList": [
{
"actionResult": {
"otherIndexContext": {},
"actionResultId": 0,
"refNo": "string",
"esIndexNeedDtoList": [
{
"module": null,
"refNo": null,
"version": null,
"mainEntity": null,
"tags": null,
"delete": null
}
],
"changedMainDtos": [
{
"key": null,
"value": null
}
]
},
"module": "NONE"
}
],
"refNo": "string",
"params": {},
"otherIndexContext": {
"actionResult": {
"otherIndexContext": {},
"actionResultId": 0,
"refNo": "string",
"esIndexNeedDtoList": [
{
"module": "NONE",
"refNo": "string",
"version": 0,
"mainEntity": {
"version": null,
"createActionKey": null,
"refNo": null,
"status": null,
"createUser": null,
"updatedOn": null,
"businessRefNo": null,
"partiesList": null,
"docTagList": null,
"docStatus": null,
"get_overrideCreateUser": null,
"get_overrideCreateUserName": null
},
"tags": [
null
],
"delete": false
}
],
"changedMainDtos": [
{
"key": {
"id": null,
"version": null,
"refNo": null,
"domainId": null,
"status": null,
"hubDomainId": null,
"amIOwner": null,
"partiesList": null,
"initializePartyByDocumentId": null,
"docTagList": null,
"docStatus": null,
"fromImport": null
},
"value": {
"id": null,
"version": null,
"refNo": null,
"domainId": null,
"status": null,
"hubDomainId": null,
"amIOwner": null,
"partiesList": null,
"initializePartyByDocumentId": null,
"docTagList": null,
"docStatus": null,
"fromImport": null
}
}
]
},
"module": "NONE"
},
"changedMainDtos": [
{
"key": {
"id": "string",
"version": 0,
"refNo": "string",
"domainId": "string",
"status": "string",
"hubDomainId": "string",
"amIOwner": false,
"partiesList": [
{
"revision": null,
"entityVersion": null,
"domainId": null,
"hubDomainId": null,
"isForReference": null,
"internalSeqNo": null,
"duid": null,
"partyNameSeqNo": null,
"contactUserSeqNo": null,
"isOwner": null,
"partyName": null,
"contactUser": null
}
],
"initializePartyByDocumentId": "string",
"docTagList": [
{
"id": null,
"refNo": null,
"revision": null,
"entityVersion": null,
"domainId": null,
"hubDomainId": null,
"isForReference": null,
"version": null,
"status": null,
"docStatus": null,
"editingStatus": null,
"amIOwner": null
}
],
"docStatus": "string",
"fromImport": false
},
"value": {
"id": "string",
"version": 0,
"refNo": "string",
"domainId": "string",
"status": "string",
"hubDomainId": "string",
"amIOwner": false,
"partiesList": [
{
"revision": null,
"entityVersion": null,
"domainId": null,
"hubDomainId": null,
"isForReference": null,
"internalSeqNo": null,
"duid": null,
"partyNameSeqNo": null,
"contactUserSeqNo": null,
"isOwner": null,
"partyName": null,
"contactUser": null
}
],
"initializePartyByDocumentId": "string",
"docTagList": [
{
"id": null,
"refNo": null,
"revision": null,
"entityVersion": null,
"domainId": null,
"hubDomainId": null,
"isForReference": null,
"version": null,
"status": null,
"docStatus": null,
"editingStatus": null,
"amIOwner": null
}
],
"docStatus": "string",
"fromImport": false
}
}
]
}
}
Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.
Was this page helpful?