CHchrt
/shipping_integrations

Status summary

Changed on

Counts the caller's shipping integration orders by unified status. | () -> (ShippingIntegrationOrderStatusSummaryRes)

get/shipping_integrations/orders/status_summary/v1

Request

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

Query parameters

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

staged_countinteger required
in_progress_countinteger required
completed_countinteger required
cancelled_countinteger required
exception_countinteger required
total_countinteger required

Changes

  • b5a0a0e20ff8Revision changes
    • info

      added the new optional query request parameter filter_shipping_integration_order_ids

  • 9a30893d8db1Revision changes
    • info

      added the enum value courie to the property anyOf[subschema #1]/items/ of the query request parameter filter_shipping_integration