Get Trades Negotiations

GET /api/v1/trades/negotiations

Description

Retrieve trade negotiations.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
tenantId	string	The tenant ID (header)
userId	string	The user ID (header)
countryCode	string	The country code (header)

Query Parameters

Name	Type	Description
tradeDateRange	string	e.g: 2020-11-12,2022-11-15
productUnitTypes	string	Available values: BARRELS, CUBIC_FEET, GALLONS, GRAMS, KILOGRAMS, LITRES, POUNDS, METRIC_TONNES
tradeWithSabi	string	Available values: 0, 1
tradeInitiatedByBuyer	string	Available values: 0, 1
tradeByRequestIds	string
tradeStatuses	string	Available values: DRAFT, NEGOTIABLE
tradeRequestStatuses	string	Available values: PENDING, ACCEPTED, REJECTED
tradeByProductIds	string
tradeIds	string
byStates	string
byCities	string
bySellerIds	string
byBuyerIds	string
byBusinessIds	string
order	string	Available values: ASC, DESC
page	string
limit	string

Example

GET /api/v1/trades/negotiations
tenantId: string
userId: string
countryCode: string
tradeDateRange: 2020-11-12,2022-11-15
productUnitTypes: BARRELS
tradeWithSabi: 1
tradeInitiatedByBuyer: 1
tradeStatuses: NEGOTIABLE
tradeRequestStatuses: ACCEPTED
order: ASC
page: 1
limit: 10

Response Code: 200 - OK

Description

Successful response with trade negotiations data.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the trade negotiations
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Trade negotiations retrieved successfully",
  "data": {},
  "errors": []
}

Headers

Content-Type	Value
apiKey	{{apiKey}}
tenantId	string
userId	string
countryCode	string

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string