CHchrt
/shipping_integrations

List

Changed on

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

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping_integrations/atlas/orders/list/v1
  • Auth
    HTTP bearer

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

pageinteger

Page number (1-indexed)

searchstring nullable

Search Atlas order IDs.

filter_atlas_order_idsstring[] nullable

Filter by atlas order IDs

filter_provider_org_idstring[] nullable

Filter by provider org ID(s)

filter_integration_order_idstring nullable

Filter by Atlas's exact order ID

filter_mirrored_at_timestamp_gtestring date-time nullable

Filter mirrored_at_timestamp >= value

filter_mirrored_at_timestamp_ltestring date-time nullable

Filter mirrored_at_timestamp <= value

filter_created_at_timestamp_gtestring date-time nullable

Filter created_at_timestamp >= value

filter_created_at_timestamp_ltestring date-time nullable

Filter created_at_timestamp <= value

filter_updated_at_timestamp_gtestring date-time nullable

Filter updated_at_timestamp >= value

filter_updated_at_timestamp_ltestring date-time nullable

Filter updated_at_timestamp <= value

Response

Successful Response

total_countinteger required

Changes

  • 5e62049a1c19Revision changes
    • info

      added the optional property //// to the response with the status

  • b5a0a0e20ff8Revision changes
    • info

      added the new optional query request parameter filter_atlas_order_ids