Skip to main content

Confirm Freight in Trade Tracking Pipeline

PATCH /api/v1/trade-tracking-pipeline/freights/confirmation

Description

Confirm a freight in the trade tracking pipeline.

Path Parameters

NameTypeDescription
NoneNo parameters

Request Headers

NameTypeDescription
tenantIdstringThe tenant ID (header)
userIdstringThe user ID (header)
countryCodestringThe country code (header)

Request Body

  • Content Type: application/json
{
"trade": "string",
"processFlow": "string",
"amount": 0,
"proofOfPayment": "string",
"testResult": "string",
"status": true,
"dateTimeStamp": "2024-07-13T01:23:17.765Z",
"userId": "string",
"tenantId": "string",
"countryCode": "string"
}

Response Code: 200 - OK

Description

Freight confirmed successfully.

Headers

Content-TypeValue
apiKey{{apiKey}}
tenantIdstring
userIdstring
countryCode string

Body

{
"trade": "Trade1",
"processFlow": "Flow1",
"amount": 5000,
"proofOfPayment": "receipt123",
"testResult": "Pass",
"status": true,
"dateTimeStamp": "2024-07-13T01:23:17.765Z",
"userId": "user123",
"tenantId": "tenant123",
"countryCode": "US"
}

🔑 Authentication bearer

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/trade-tracking-pipeline/freights/confirmation \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!