---
title: "List"
method: GET
path: "/shipping_integrations/orders/list/v1"
tags: ["/shipping_integrations"]
---

# List

`GET /shipping_integrations/orders/list/v1`

Lists the caller's orders from every shipping integration with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (ShippingIntegrationOrderListRes)

## Query parameters

- `sort_by` 'ordered_at_timestamp' | 'completed_at_timestamp' | 'last_mirrored_at_timestamp' | 'first_mirrored_at_timestamp' | 'status'
- `sort_order` 'asc' | 'desc' — Sort order for query results
- `page` integer
- `page_size` integer
- `search` string, nullable — Search provider order IDs and reference numbers.
- `filter_shipping_integration` OrgShippingIntegrationEnum1[], nullable — Filter by shipping integration(s)
- `filter_provider_org_id` string[], nullable — Filter by provider org ID(s)
- `filter_status` ShippingIntegrationOrderStatusEnum1[], nullable — Filter by unified status(es)
- `filter_integration_order_id` string, nullable — Filter by the provider's exact order ID
- `filter_reference_number` string, nullable — Filter by an exact reference number carried on the order
- `filter_ordered_at_timestamp_gte` string, date-time, nullable — Filter ordered_at_timestamp >= value
- `filter_ordered_at_timestamp_lte` string, date-time, nullable — Filter ordered_at_timestamp <= value
- `filter_completed_at_timestamp_gte` string, date-time, nullable — Filter completed_at_timestamp >= value
- `filter_completed_at_timestamp_lte` string, date-time, nullable — Filter completed_at_timestamp <= value
- `filter_last_mirrored_at_timestamp_gte` string, date-time, nullable — Filter last_mirrored_at_timestamp >= value
- `filter_last_mirrored_at_timestamp_lte` string, date-time, nullable — Filter last_mirrored_at_timestamp <= value
- `filter_first_mirrored_at_timestamp_gte` string, date-time, nullable — Filter first_mirrored_at_timestamp >= value
- `filter_first_mirrored_at_timestamp_lte` string, date-time, nullable — Filter first_mirrored_at_timestamp <= value

## Response `200`

Successful Response

- ShippingIntegrationOrderListRes
  - `items` ShippingIntegrationOrderExpanded1[], required
    - `schema_version` 1, required
    - `_id` string, required
    - `org_id` string, required — Must be a string starting with `org_`
    - `shipping_integration` 'xcelerator' | 'dispatch_science' | 'ontime360' | 'cxt' | 'atlas' | 'ecourier', required
    - `provider_org_id` string, required — Must be a string starting with `org_`
    - `integration_order_id` string, required
    - `reference_numbers` string[]
    - `status` 'staged' | 'in_progress' | 'completed' | 'cancelled' | 'exception', required
    - `provider_status_raw` string, nullable
    - `origin` ShippingIntegrationOrderPlace1 — unresolved $ref
    - `destination` ShippingIntegrationOrderPlace1 — unresolved $ref
    - `stop_count` integer, nullable
    - `ordered_at_timestamp` string, date-time, nullable
    - `in_progress_at_timestamp` string, date-time, nullable
    - `in_progress_at_provenance` 'reported' | 'derived'
    - `completed_at_timestamp` string, date-time, nullable
    - `completed_at_provenance` 'reported' | 'derived'
    - `source_provider_payload_hash` string, required
    - `first_mirrored_at_timestamp` string, date-time, required
    - `last_mirrored_at_timestamp` string, date-time, required
    - `provider_org` OrgPublicData1 — unresolved $ref
    - `shipper_org` OrgPublicData1 — unresolved $ref
  - `total_count` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/chrt/apis/chrt-fastapi.md) · [All operations](https://skmtc.dev/chrt/apis/chrt-fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/chrt/chrt-fastapi/revisions/ea04e157edb3/schema)