Vendors
Search vendors
Search vendors using OpenSearch-powered full-text and field-specific search.
This endpoint provides fast, indexed search across vendor data with support for:
- Full-text search across multiple fields
- Field-specific filtering with various operators
- Sorting and pagination
- Saved search preferences
Note: Only active (non-deleted) vendors are searchable. Soft-deleted records are automatically excluded from all search results.
Response Formats:
- flat (default): Returns indexed fields only for faster performance
- full: Returns complete vendor objects with all relationships
post/vendors/search
Request body
Example request
{
"criteria": {
"id": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"friendlyId": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"name": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"status": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"service": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"taxId": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"location": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"city": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"state": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"zip": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"country": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"primaryContactName": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"primaryContactEmail": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"primaryContactPhone": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"paymentTermName": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"quickbooksVendorId": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"numberOfTimesUsed": {
"operator": "BETWEEN",
"min": 10,
"max": 100
},
"lastUsed": {
"operator": "BETWEEN",
"min": "2025-01-01",
"max": "2025-01-31"
},
"createdAt": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
}
},
"pagination": {
"pageNumber": 1,
"pageSize": 50
},
"sort": [
{
"field": "createdAt",
"order": "desc"
}
],
"savedSearch": {
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}Response
Successful search results
Example response
{
"data": [
{
"object": "VENDOR",
"id": "550e8400-e29b-41d4-a716-446655440000",
"friendlyId": "V123456",
"name": "ABC Warehouse Services",
"key": "ERP-VENDOR-ABC-001",
"email": "billing@abcwarehouse.com",
"phone": "+1-555-123-4567",
"status": "ACTIVE",
"notes": "Preferred vendor for warehouse services",
"taxId": "12-3456789",
"corporateAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"billingAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"requiredDocuments": [
"W9",
"INSURANCE_CERTIFICATE"
],
"paymentMethods": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "VENDOR-PM-001",
"paymentMethodType": "ACH",
"status": "ACTIVE",
"isPreferred": true,
"email": "payments@vendor.com",
"phone": "+1-555-123-4567",
"companyName": "Vendor Payments LLC",
"username": "vendor_payments",
"bankName": "Chase Bank",
"bankAddress": "123 Bank Street, Dallas, TX 75201",
"accountName": "Vendor Services Inc",
"accountNumber": "****1234",
"abaAch": "021000021",
"wire": "026009593",
"swiftCode": "CHASUS33",
"eftInstitution": "001",
"eftTransit": "00010",
"clabe": "012180001234567897",
"currency": "USD",
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z",
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"contacts": [
{
"object": "VENDOR_CONTACT",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-VENDOR-CONTACT-001",
"email": "john.smith@abcwarehouse.com",
"phone": "+1-555-123-4567",
"role": "Billing Manager",
"roles": [
"BILLING",
"AGENT"
],
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z"
}
],
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
],
"pagination": {
"pageNumber": 1,
"pageSize": 50,
"totalPages": 25
}
}