Search trading community
GET {{baseUrl}}/v1/companies/:companyId/partnerDirectory?partnerCompanyId=et ullamco culpa&partnerCompanyName=et ullamco culpa&partnerCompanyDisplayName=et ullamco culpa&countOnly=true&page=-77466342&pageSize=-77466342&tradingAddress=et ullamco culpa&creationStartDate=et ullamco culpa&creationEndDate=et ullamco culpa&partnerCompanyStatus=et ullamco culpa
Search your trading community based on your company ID; search options include partner ID, name, display name, status, trading address, count, creation start and end date. This API supports pagination by taking number of records into account
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
partnerCompanyId | string | Partner company identifier. Maximum length: 20 | |
partnerCompanyName | string | Partner company name. Maximum length: 100 | |
partnerCompanyDisplayName | string | Partner company display name or facade name. Maximum length: 100 | |
countOnly | boolean | Returns the record count based on the search criteria. Allowed values: true or false | |
page | number | Page is the start index of the requested set of records. Allowed values: Numeric value. Minimum value: 0, Maximum value: Total number of records - 1 | |
pageSize | number | PageSize is the number of records requested. Allowed values: Numeric value. Minimum value: 0, Maximum value: 100 | |
tradingAddress | string | Trading Address of partner company. Minimum length: 2, Maximum length: 35 | |
creationStartDate | string | Creation start date and it should be combined with creation end date. Date format: DD/MM/YYYY | |
creationEndDate | string | Creation end date and it should be combined with creation start date. Date format: DD/MM/YYYY | |
partnerCompanyStatus | string | Partner company status. Allowed values: active or inactive |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"bprId":"ipsum","facadeId":"enim laborum","partnerCompanyDisplayName":"incidid","partnerCompanyId":"irure aliqua","partnerCompanyName":"in consec","partnershipActivationDate":"aliquip officia ea","partnershipStatus":"cillum dolore"},{"bprId":"consequat dolor velit aute proident","facadeId":"ad sit nostrud eu","partnerCompanyDisplayName":"elit culpa nostrud occaecat","partnerCompanyId":"dolore veniam","partnerCompanyName":"sunt id incididunt ea","partnershipActivationDate":"est ","partnershipStatus":"exercitation"}]