CHchrt
/shipping_integrations

List

Changed on

Lists mirrored OnTime360 orders for the caller's organization with filtering, sorting, pagination, and optional search. | () -> (OnTime360OrderListRes)

get/shipping_integrations/ontime360/orders/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping_integrations/ontime360/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 order (asc or desc).

pageinteger
page_sizeinteger
searchstring nullable

Search OnTime360 order IDs.

filter_ontime360_order_idsstring[] nullable

Filter by ontime360 order IDs

filter_provider_org_idstring[] nullable

Filter by provider org ID(s)

filter_integration_order_idstring nullable

Filter by OnTime360's exact order GUID

filter_provider_status_level0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Operational status of an order.

The live OpenAPI spec declares StatusLevel and Status.Level as enum name strings while the wire format is the integer ordinal, so the validator below accepts either. Ordinals are the vendor's own and are what we store.

Filter by OnTime360's raw status level

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