Search orders and route stops
cxt_search_shipmentsSearch orders and route stops by place, address, city, state, postal code, order template, or only by date range. tracking_type says which field search_criteria is matched against: Location (origin/destination or stop name), Address, City, State, Postal (zip or zip+4), Template (order template name), Tracking (references/barcodes) or DateOnly (no criteria: everything between begin_date and end_date). Returns shipment summaries, up to 1000 per page. An INET login sees the most detail; with an Operations App login this endpoint is called without credentials (CXT lists only internet users and anonymous callers for it), so the view is limited. Costs 1 API credit with the vendor. POST /v2/Shipments/Summaries.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | A date (2026-10-01) or an ISO 8601 date-time with a timezone, e.g. 2026-10-01T08:00:00Z. | |
| page_num | No | CXT's pageNum, documented as 'the offset for the records to return' (default 0). When has_more is true, ask for the next records and check the new page does not repeat the previous one (if it does, pageNum counts records: use a multiple of page_size). | |
| page_size | No | Results per page, 1-1000 (default 50). | |
| begin_date | No | A date (2026-10-01) or an ISO 8601 date-time with a timezone, e.g. 2026-10-01T08:00:00Z. | |
| tracking_type | Yes | Which field search_criteria matches. | |
| search_criteria | No | Values to match (omit for DateOnly). | |
| include_partial_match | No | Also return partial matches (default false). |