POST Search Vendors
Search for one or more vendors by certain criteria
Header Parameters
- x-forwarded-for X-Forwarded-For
- Accept Accept
- Content-Type Content-Type
- application/vnd.stavvy-1.0+json
Request Body required
- branch Branch
- domain Domain
location object required
streetNumber Streetnumber requiredstreetName Streetname requiredapartmentUnit Apartmentunitcounty Countycity City requiredusState Usstate requiredpostalCode Postalcode required- contactPhone Contactphone required
- contactEmail Contactemail required
- name Name required
Responses
- 200
- 401
- 403
- 422
Was able to successfully search for a vendor
- application/vnd.stavvy-1.0+json
- Schema
- Example (from schema)
Schema
matches object[] required
Array [userMatch object required
userName UsernameuserEmail UseremailmatchFound Matchfound requiredcompanyName CompanynamebranchAddress object
street Street requiredapartmentUnit Apartmentunit requiredcity City requiredcounty County requiredstate State requiredpostalCode Postalcode requiredbranchPhone BranchphonebranchURL BranchurlvendorGuid uuid requiredidToSendToStavvy Idtosendtostavvy requiredaddressConfidence AddressconfidencenameConfidence Nameconfidencestatus object required
connected ConnectedvendorFieldOfficeGuid uuid]
{
"matches": [
{
"userMatch": {
"userName": "string",
"userEmail": "string",
"matchFound": true
},
"companyName": "string",
"branchAddress": {
"street": "string",
"apartmentUnit": "string",
"city": "string",
"county": "string",
"state": "string",
"postalCode": "string"
},
"branchPhone": "string",
"branchURL": "string",
"vendorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"idToSendToStavvy": "string",
"addressConfidence": 0,
"nameConfidence": 0,
"status": {
"connected": true
},
"vendorFieldOfficeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Was not authorized to lookup a vendor
Did not have the correct permissions to look up a vendor
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
detail object[]
Array [loc object[] required
Array [- anyOf
- MOD1
- MOD2
stringinteger]msg Message requiredtype Error Type required]
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...