v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Analytics

List Analytics Shipment Status Data

Retrieve shipment status. Possible statuses:

  • Label Pending
  • Label Rejected
  • Label Ready
  • Pickup/Drop-off in Progress
  • In Transit to Customer
  • Failed Delivery Attempt
  • Exception

Required authorization scope: public.analytics:read

get/2024-09/analytics/shipment_status

Query parameters

from_datestring required

Beginning of date. Only accept YYYY-MM-DD format.

to_datestring required

End of date. Only accept YYYY-MM-DD format.

Response

list of shipments count group by status