younifyd
Menu

/api/purchase_orders/chainOfCustody/summary/{vpoId}

Get Chain of Custody Summary Dto

GET/api/purchase_orders/chainOfCustody/summary/{vpoId}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/purchase_orders/chainOfCustody/summary/{vpoId} action (under VendorPurchaseOrderController).
  3. Fill in the fields below, then reference the result from later steps as {{apiPurchaseOrdersChainofcustodySummaryVpoid.response.data}}.

Request

Path parameters

vpoIdstringrequired

Response

Returns 200 with an object. Read it in later steps with {{apiPurchaseOrdersChainofcustodySummaryVpoid.response.data.<field>}}.

vpoChainOfCustodySummaryDetailDtoListarray<object>
sectionSeqNointeger (int32)
sectionNamestring
seqNointeger (int32)
descriptionstring
chainOfCustodyStatusobject3 fields
chainOfCustodySupplierobject16 fields
blacklistedEntitystring

One ofFAILUREWARNINGUNDETECTEDIN_PROGRESSSUCCESSNOT_AVAILABLEERROR

originRisksstring

One ofFAILUREWARNINGUNDETECTEDIN_PROGRESSSUCCESSNOT_AVAILABLEERROR

analysisIdstring
vpoChainOfCustodySummaryOverallDtoobject
blacklistedEntitystring

One ofFAILUREWARNINGUNDETECTEDIN_PROGRESSSUCCESSNOT_AVAILABLEERROR

originRisksstring

One ofFAILUREWARNINGUNDETECTEDIN_PROGRESSSUCCESSNOT_AVAILABLEERROR

overallResultstring

One ofFAILUREWARNINGUNDETECTEDIN_PROGRESSSUCCESSNOT_AVAILABLEERROR

vpoChainOfCustodySummaryDetailStatusDtoListarray<object>4 fields
json
{
  "vpoChainOfCustodySummaryDetailDtoList": [
    {
      "sectionSeqNo": 0,
      "sectionName": "string",
      "seqNo": 0,
      "description": "string",
      "chainOfCustodyStatus": {
        "code": "string",
        "name": "string",
        "version": 0
      },
      "chainOfCustodySupplier": {
        "id": "string",
        "refNo": "string",
        "version": "string",
        "status": "string",
        "businessName": "string",
        "city": "string",
        "type": "string",
        "module": "NONE",
        "gpsLng": "string",
        "gpsLat": "string",
        "country": {
          "code": "string",
          "name": "string",
          "version": 0
        },
        "facilityTypeList": [
          {
            "code": "string",
            "name": "string",
            "version": 0
          }
        ]
      },
      "blacklistedEntity": "FAILURE",
      "originRisks": "FAILURE",
      "analysisId": "string"
    }
  ],
  "vpoChainOfCustodySummaryOverallDto": {
    "blacklistedEntity": "FAILURE",
    "originRisks": "FAILURE",
    "overallResult": "FAILURE",
    "vpoChainOfCustodySummaryDetailStatusDtoList": [
      {
        "sectionName": "string",
        "chainOfCustodyStatus": {
          "code": "string",
          "name": "string",
          "version": 0
        },
        "originRisks": "FAILURE",
        "blacklistedEntity": "FAILURE"
      }
    ]
  }
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.