Sign in
/shipping_integrations

List

Lists mirrored Courie orders for the caller's organization with filtering, sorting, and pagination. | () -> (CourieOrderListRes)

get/shipping_integrations/courie/orders/list/v1

Query parameters

sort_by'mirrored_at_timestamp' | 'created_at_timestamp' | 'updated_at_timestamp' | 'integration_order_id'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc).

pageinteger
page_sizeinteger
filter_provider_org_idstring[] nullable

Filter by provider org ID(s)

Filter by provider org ID(s)

filter_integration_order_idstring nullable

Filter by Courie's exact order ID

Filter by Courie's exact order ID

filter_customer_idstring nullable

Filter by the Courie customer the order belongs to

Filter by the Courie customer the order belongs to

filter_provider_status'CREATED' | 'ASSIGNED' | 'IN_TRANSIT' | 'COMPLETED' | 'ATTEMPTED' | 'ON_HOLD' | 'DELETED' | 'FAILED'

Courie's own order status.

The spec documents these only as a bare enum list with no per-value meaning. IN_TRANSIT, ON_HOLD and DELETED have not been observed live. unified.py derives progress from the pickup milestone rather than this field.

Filter by Courie's own order status

filter_mirrored_at_timestamp_gtestring date-time nullable

Filter mirrored_at_timestamp >= value

Filter mirrored_at_timestamp >= value

filter_mirrored_at_timestamp_ltestring date-time nullable

Filter mirrored_at_timestamp <= value

Filter mirrored_at_timestamp <= value

filter_created_at_timestamp_gtestring date-time nullable

Filter created_at_timestamp >= value

Filter created_at_timestamp >= value

filter_created_at_timestamp_ltestring date-time nullable

Filter created_at_timestamp <= value

Filter created_at_timestamp <= value

filter_updated_at_timestamp_gtestring date-time nullable

Filter updated_at_timestamp >= value

Filter updated_at_timestamp >= value

filter_updated_at_timestamp_ltestring date-time nullable

Filter updated_at_timestamp <= value

Filter updated_at_timestamp <= value

Response

Successful Response

total_countinteger required

Changes

Changed in 1 of the 9 revisions of this API.1