Sign in
/shipping_integrations

List

Returns a paginated list of mirrored Atlas orders with provider organizations expanded, filtering, sorting, pagination, and optional search. | (AtlasOrderListFilters) -> (AtlasOrderListRes)

get/shipping_integrations/atlas/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 direction

limitinteger

Max items to return

Max items to return

pageinteger

Page number (1-indexed)

Page number (1-indexed)

searchstring nullable

Search Atlas order IDs.

Search Atlas order IDs.

filter_provider_org_idstring[] nullable

Filter by provider org ID(s)

Filter by provider org ID(s)

filter_integration_order_idstring nullable

Filter by Atlas's exact order ID

Filter by Atlas's exact order ID

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

No recorded changes to this endpoint across all 1 revision of this API.