The POST Search Vendors method allows you to query vendors records based on various filter criteria, such as vendor ID, and status. This method returns a paginated list of matching vendor records, including details like payment method, physical address and remittance address.
Note: This API is supported in AndDone version 2.3 only.
|
URI
|
merchants/vendors/search
|
|
Method
|
POST
|
|
Authorization
|
API Key Authorization
|
|
x-api-key
|
API key {env_merchantAccessKey}
|
|
x-app-key
|
Merchant ID or App Key {env_merchantId}
|
|
x-version
|
API version (e.g., 2.3)
|
|
Origin
|
URL or IP address provided to AndDone as an allowed origin.
|
|
Content-Type
|
application/json
|
Query Parameters
| vendorName |
Filters results by the vendor's name. |
| attention |
Filters results by the attention line or contact person associated with the vendor. |
| vendorID |
Filters results by the unique vendor ID. |
| paymentMethodType |
Filters results by the type of payment method used (e.g., ACH, Checks, Wire). |
| createdOn |
Filters results by the date the vendor record was created. Format: MM-DD-YYYY. |
| createdBy |
Filters results by the user who created the vendor record. |
| vendorStatus |
Filters results by the vendor’s status. |
Request
Response
Body Response Example (JSON)
{
"totalRowCount": 3,
"data": [
{
"id": "VxjOQe98",
"paymentBasedId": "CVxjOQe98",
"legalEntityType": "LimitedLiabilityCompany",
"merchantId": "Vn8M1N82",
"vendorName": "Srilalitha Supplychain",
"vendorAliasName": null,
"vendorDbName": "Srilalitha Supplychain",
"paymentMethodType": "Checks",
"notificationType": "Email",
"vendorNotes": null,
"phoneNumber": "2147896321",
"isMobileNumber": false,
"email": "[email protected]",
"url": null,
"vendorStatus": "Deleted",
"useSameAsPhysicalAddress": true,
"physicalAddress": {
"vendorId": "VxjOQe98",
"attention": "Sri lalitha N",
"addressLine1": "1055 Broadway Blvd",
"addressLine2": "4th floor",
"city": "Kansas City",
"state": "MO",
"country": "US",
"postalCode": "64105",
"addressType": "Physical",
"addressSource": "Manual",
"verificationStatus": "Valid"
},
"remittanceAddress": {
"vendorId": "VxjOQe98",
"attention": "Sri lalitha N",
"addressLine1": "1055 Broadway Blvd",
"addressLine2": "4th floor",
"city": "Kansas City",
"state": "MO",
"country": "US",
"postalCode": "64105",
"addressType": "Remittance",
"addressSource": "Manual",
"verificationStatus": "Valid"
},
"verificationResults": [],
"createdBy": "SriTestQATliveIP",
"modifiedBy": "SriTestQATliveIP",
"createdOn": "03-20-2025 04:57:24",
"modifiedOn": "03-21-2025 11:02:53",
"approvedDate": "03-21-2025 11:00:38",
"template": null
},
{
"id": "2v6LbQ28",
"paymentBasedId": "C2v6LbQ28",
"legalEntityType": "Individual",
"merchantId": "Vn8M1N82",
"vendorName": "Mia test",
"vendorAliasName": null,
"vendorDbName": "Mia test demo",
"paymentMethodType": "Checks",
"notificationType": "Email",
"vendorNotes": null,
"phoneNumber": "2147896321",
"isMobileNumber": false,
"email": "[email protected]",
"url": null,
"vendorStatus": "Approved",
"useSameAsPhysicalAddress": true,
"physicalAddress": {
"vendorId": "2v6LbQ28",
"attention": "Mia H",
"addressLine1": "4900 Throne Hall Dr",
"addressLine2": "",
"city": "frisco",
"state": "TX",
"country": "US",
"postalCode": "75033",
"addressType": "Physical",
"addressSource": "Manual",
"verificationStatus": "Valid"
},
"remittanceAddress": {
"vendorId": "2v6LbQ28",
"attention": "Mia H",
"addressLine1": "4900 Throne Hall Dr",
"addressLine2": "",
"city": "frisco",
"state": "TX",
"country": "US",
"postalCode": "75033",
"addressType": "Remittance",
"addressSource": "Manual",
"verificationStatus": "Valid"
},
"verificationResults": [],
"createdBy": "SriTestQATliveIP",
"modifiedBy": "SriTestQATliveIP",
"createdOn": "03-21-2025 10:47:41",
"modifiedOn": "03-25-2025 14:32:08",
"approvedDate": "03-21-2025 10:53:51",
"template": null
},
{
"id": "bvl94AJx",
"paymentBasedId": null,
"legalEntityType": "Individual",
"merchantId": "Vn8M1N82",
"vendorName": "Vendor with Address more than 35 charcaters",
"vendorAliasName": null,
"vendorDbName": "Vendor with Address",
"paymentMethodType": "Checks",
"notificationType": "Email",
"vendorNotes": null,
"phoneNumber": "2147896321",
"isMobileNumber": false,
"email": "[email protected]",
"url": null,
"vendorStatus": "Reviewing",
"useSameAsPhysicalAddress": true,
"physicalAddress": {
"vendorId": "bvl94AJx",
"attention": "Sri lalitha N",
"addressLine1": " 12345 long street Name That is Too Long for printing",
"addressLine2": "12345 long street Name That is Too Long for printing",
"city": "chargoggagoggmanchauggagoggchaubunagungamaugg",
"state": "TX",
"country": "US",
"postalCode": "75033-3333",
"addressType": "Physical",
"addressSource": "Manual",
"verificationStatus": "NA"
},
"remittanceAddress": {
"vendorId": "bvl94AJx",
"attention": "Sri lalitha N",
"addressLine1": " 12345 long street Name That is Too Long for printing",
"addressLine2": "12345 long street Name That is Too Long for printing",
"city": "chargoggagoggmanchauggagoggchaubunagungamaugg",
"state": "TX",
"country": "US",
"postalCode": "75033-3333",
"addressType": "Remittance",
"addressSource": "Manual",
"verificationStatus": "Invalid"
},
"verificationResults": [],
"createdBy": "SriTestQATliveIP",
"modifiedBy": "System",
"createdOn": "03-24-2025 17:10:18",
"modifiedOn": "03-24-2025 17:10:22",
"approvedDate": null,
"template": null
}
]
}