Search globally

Search across multiple entity types simultaneously (shipments, customers, carriers, users, vendors).

Use Cases:

• Unified search bar for finding any type of record
• Quick lookup by name, ID, or reference number
• Cross-entity discovery

Search Behavior:

• Searches across default searchable fields for each entity type
• Results are sorted by object type priority: SHIPMENT → CUSTOMER → CARRIER → USER → VENDOR
• Within each object type, results are sorted by most recently updated

Prefix Filtering: Use "type:query" syntax to search specific object types:

• carrier:acme - searches only carriers
• shipment:12345 - searches only shipments
• customer:west - searches only customers

IMPORTANT: Eventually Consistent This endpoint queries OpenSearch indices which are updated asynchronously. Changes typically appear within 2 seconds, but this is not guaranteed.

{
  "query": "acme corp",
  "objects": [
    "SHIPMENT",
    "CUSTOMER"
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50
  }
}

{
  "data": [
    {
      "key": "ERP-CUST-12345",
      "entityName": "SHIPPER_PROFILE",
      "title": "Acme Corporation",
      "subtitle": "CUST-12345",
      "field": "Name",
      "highlight": "<em>Acme</em> Corporation"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalPages": 25
  },
  "totalResults": 42
}