v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Quotes

Filter quotes

Search for quotes using filter criteria.

Common Filters

  • Active quotes: { "filter": { "status": { "in": ["DRAFT", "REQUESTED", "QUOTED"] } } }
  • Won quotes: { "filter": { "status": { "equalTo": "WON" } } }
  • By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
  • Expiring soon: { "filter": { "expiresAt": { "lessThanOrEqualTo": "2025-01-20T00:00:00Z" } } }
post/quotes/filter

Request body

pageSizeinteger
cursorstring

Response

Quotes matching filter criteria

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "Q003602",
      "amount": 2500,
      "target": 2200,
      "margin": 12,
      "customer": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CUSTOMER-ACME",
        "name": "Acme Manufacturing Corp",
        "friendlyId": "A123456",
        "status": "ACTIVE",
        "phoneNumber": "+1-555-123-4567",
        "website": "https://acme-manufacturing.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "carrier": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CARRIER-SWIFT",
        "name": "Swift Transportation",
        "phoneNumber": "+1-555-987-6543",
        "email": "dispatch@swifttrans.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "assignee": {
        "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"
      }
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}