Sonaar External API Documentation (1.0.0)

Download OpenAPI specification:

Documentation for Sonaar External API

Tenders

Tenders endpoints

List all tenders

Returns page-based tender list for authenticated client API key. Visibility matches current client tender scope, with legacy pageNumber / pageSize.

Authorizations:

ApiKeyAuth

query Parameters

pageNumber	integer Default: 1 Page number
pageSize	integer Default: 10 Items per page

header Parameters

X-Correlation-Id

string

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"uid": "string",
"externalReference": "string",
"procurementType": "string",
"status": "AWARDED",
"publicationAt": "string",
"submissionAt": "string",
"awardedAt": "string",
"lastDispatchedAt": "string",
"languages": ["EN"
],
"titles": [{"language": "EN",
"text": "string"
}
],
"description": [{"language": "EN",
"text": "string"
}
],
"cpvCodes": ["string"
],
"estimatedValueAmount": 0,
"totalValueAmount": 0,
"accreditations": [{"categoryCode": "string",
"class": 0
}
],
"names": [{"language": "EN",
"text": "string"
}
],
"region": "string",
"name": "string",
"buyerCompanyUid": "string",
"buyerCompanyNames": [{"language": "EN",
"text": "string"
}
],
"buyerCompanyRegion": "string",
"statusUid": "string",
"statusName": "string",
"tagUid": "string",
"tagName": "string"
}
],
"pagination": {"page": 1,
"pageSize": 10,
"totalCount": 0,
"totalPages": 0
}
}

Get details about a given tender

Returns details for a given tender. Access is restricted to authenticated clients.

Authorizations:

ApiKeyAuth

path Parameters

uid

required

string <uuid>

Tender UID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"uid": "string",
"externalReference": "string",
"procurementType": "string",
"status": "AWARDED",
"publicationAt": "string",
"submissionAt": "string",
"awardedAt": "string",
"lastDispatchedAt": "string",
"languages": ["EN"
],
"titles": [{"language": "EN",
"text": "string"
}
],
"description": [{"language": "EN",
"text": "string"
}
],
"cpvCodes": ["string"
],
"estimatedValueAmount": 0,
"totalValueAmount": 0,
"accreditations": [{"categoryCode": "string",
"class": 0
}
],
"names": [{"language": "EN",
"text": "string"
}
],
"region": "string",
"name": "string",
"buyerCompanyUid": "string",
"buyerCompanyNames": [{"language": "EN",
"text": "string"
}
],
"buyerCompanyRegion": "string",
"statusUid": "string",
"statusName": "string",
"tagUid": "string",
"tagName": "string",
"startAt": "string",
"endAt": "string",
"duration": 0,
"renewable": true,
"renewalDuration": 0,
"awardingCriterionPrice": 0,
"awardingCriterionQuality": 0,
"exclusionCriteriaDetails": [{"language": "EN",
"text": "string"
}
],
"awarded": true
}
}

Opportunities

Opportunities endpoints

List all opportunities

Returns page-based opportunity list for authenticated client API key. Visibility matches current client opportunity scope, including 18-month forecast coverage.

Authorizations:

ApiKeyAuth

query Parameters

pageNumber	integer Default: 1 Page number
pageSize	integer Default: 10 Items per page

header Parameters

X-Correlation-Id

string

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"uid": "string",
"languages": ["EN"
],
"descriptions": [{"language": "EN",
"text": "string"
}
],
"estimatedValueAmount": 0,
"valueRangeDescription": "string",
"forecastedPublicationStartAt": "string",
"forecastedPublicationEndAt": "string",
"forecastLikelyhood": "string",
"cpvCodes": ["string"
],
"region": "string",
"pastTenderUid": "string",
"names": [{"language": "EN",
"text": "string"
}
],
"name": "string",
"buyerCompanyUid": "string",
"buyerCompanyNames": [{"language": "EN",
"text": "string"
}
],
"buyerCompanyRegion": "string",
"statusUid": "string",
"statusName": "string",
"tagUid": "string",
"tagName": "string"
}
],
"pagination": {"page": 1,
"pageSize": 10,
"totalCount": 0,
"totalPages": 0
}
}

Get details about a given opportunity

Returns details for a given opportunity. Access is restricted to authenticated clients.

Authorizations:

ApiKeyAuth

path Parameters

uid

required

string <uuid>

Opportunity UID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"uid": "string",
"languages": ["EN"
],
"descriptions": [{"language": "EN",
"text": "string"
}
],
"estimatedValueAmount": 0,
"valueRangeDescription": "string",
"forecastedPublicationStartAt": "string",
"forecastedPublicationEndAt": "string",
"forecastLikelyhood": "string",
"cpvCodes": ["string"
],
"region": "string",
"pastTenderUid": "string",
"names": [{"language": "EN",
"text": "string"
}
],
"name": "string",
"buyerCompanyUid": "string",
"buyerCompanyNames": [{"language": "EN",
"text": "string"
}
],
"buyerCompanyRegion": "string",
"statusUid": "string",
"statusName": "string",
"tagUid": "string",
"tagName": "string"
}
}

Buyers

List buyers

Returns paginated buyers for authenticated client API key.

Authorizations:

ApiKeyAuth

query Parameters

pageNumber	integer Default: 1
pageSize	integer Default: 10

header Parameters

X-Correlation-Id

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"uid": "string",
"names": [{"language": "EN",
"text": "string"
}
],
"region": "string",
"numberOfWorkers": "string",
"turnover": 0,
"ebitda": 0,
"companyNumber": "string",
"languages": ["EN"
],
"mainActivity": "string",
"phone": "string",
"email": "string",
"website": "string",
"address": "string",
"latitude": 0,
"longitude": 0
}
],
"pagination": {"page": 1,
"pageSize": 10,
"totalCount": 0,
"totalPages": 0
}
}

Get details about a given buyer

Returns details for a given buyer. Access is restricted to authenticated clients.

Authorizations:

ApiKeyAuth

path Parameters

uid

required

string <uuid>

Buyer UID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"uid": "string",
"names": [{"language": "EN",
"text": "string"
}
],
"region": "string",
"numberOfWorkers": "string",
"turnover": 0,
"ebitda": 0,
"companyNumber": "string",
"languages": ["EN"
],
"mainActivity": "string",
"phone": "string",
"email": "string",
"website": "string",
"address": "string",
"latitude": 0,
"longitude": 0
}
}

Get details about a given buyer contact

Returns details for a given buyer contact. Access is restricted to authenticated clients.

Authorizations:

ApiKeyAuth

path Parameters

uid required	string <uuid> Buyer UID
contactUid required	string <uuid> Contact UID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"uid": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"gender": "MALE",
"language": "EN",
"email": "string",
"phone": "string",
"mobile": "string",
"buyerCompanyUid": "string",
"role": "END_USER"
}
}