CHchrt
/shipping_integrations

List

Changed on

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

get/shipping_integrations/orders/list/v1

Request

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

Query parameters

sort_by'ordered_at_timestamp' | 'completed_at_timestamp' | 'last_mirrored_at_timestamp' | 'first_mirrored_at_timestamp' | 'status'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc).

pageinteger
page_sizeinteger
searchstring nullable

Search provider order IDs and reference numbers.

filter_shipping_integration_order_idsstring[] nullable

Filter by selected shipping integration order ids

filter_shipping_integrationOrgShippingIntegrationEnum1[] nullable

Filter by shipping integration(s)

filter_provider_org_idstring[] nullable

Filter by provider org ID(s)

filter_statusShippingIntegrationOrderStatusEnum1[] nullable

Filter by unified status(es)

filter_integration_order_idstring nullable

Filter by the provider's exact order ID

filter_reference_numberstring nullable

Filter by an exact reference number carried on the order

filter_ordered_at_timestamp_gtestring date-time nullable

Filter ordered_at_timestamp >= value

filter_ordered_at_timestamp_ltestring date-time nullable

Filter ordered_at_timestamp <= value

filter_completed_at_timestamp_gtestring date-time nullable

Filter completed_at_timestamp >= value

filter_completed_at_timestamp_ltestring date-time nullable

Filter completed_at_timestamp <= value

filter_last_mirrored_at_timestamp_gtestring date-time nullable

Filter last_mirrored_at_timestamp >= value

filter_last_mirrored_at_timestamp_ltestring date-time nullable

Filter last_mirrored_at_timestamp <= value

filter_first_mirrored_at_timestamp_gtestring date-time nullable

Filter first_mirrored_at_timestamp >= value

filter_first_mirrored_at_timestamp_ltestring date-time nullable

Filter first_mirrored_at_timestamp <= value

Response

Successful Response

total_countinteger required

Changes

  • 5e62049a1c19Revision changes
    • info

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

    • info

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

  • b5a0a0e20ff8Revision changes
    • info

      added the new optional query request parameter filter_shipping_integration_order_ids