Skip to main content

Create Trade Request

POST /api/trade-requests

Description​

Create a new trade request.

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
{
"productId": "string",
"requestId": "string",
"quantity": 0,
"testingRequired": true,
"productSpecification": "string",
"termsAndConditions": "string",
"docLinks": [
{
"name": "string",
"link": "string"
}
],
"businessId": "string",
"userId": "string",
"sellers": [
{
"firstName": "string",
"lastName": "string",
"username": "string",
"phone": "string",
"quantity": 0,
"country": {
"name": "string",
"code": "string",
"currency": "string"
},
"productUnitType": "Barrels",
"docLinks": [
{
"name": "string",
"link": "string"
}
]
}
],
"tenantId": "string",
"countryCode": "string"
}

Response Code: 201 - Created​

Description

Trade request created successfully.

Headers​

Content-TypeValue
apiKey{{apiKey}}
tenantIdstring
userIdstring
countryCodestring

Body​

{
"productId": "prd123",
"requestId": "req456",
"quantity": 100,
"testingRequired": true,
"productSpecification": "High quality",
"termsAndConditions": "Standard terms",
"docLinks": [
{
"name": "Specification Document",
"link": "http://example.com/specification"
}
],
"businessId": "bus789",
"userId": "usr456",
"sellers": [
{
"firstName": "Jane",
"lastName": "Doe",
"username": "janedoe",
"phone": "1234567890",
"quantity": 100,
"country": {
"name": "CountryName",
"code": "CNC",
"currency": "USD"
},
"productUnitType": "Barrels",
"docLinks": [
{
"name": "Contract Document",
"link": "http://example.com/contract"
}
]
}
],
"tenantId": "tenant123",
"countryCode": "CNC"
}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /api/trade-requests \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


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