Skip to main content

Get Dropship Performance Report

GET 
/api/reports/dropship-performance

Get on-time shipping performance for dropship-for-customer orders (orders you ship directly to a B2B retailer's consumer), per retailer, for a period.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Scope: reports (read).

Query parameters (all optional):

  • date_from (date, Y-m-d): first day of the period, inclusive, in the tenant timezone. Defaults to 29 days before date_to (a 30-day window).
  • date_to (date, Y-m-d): last day of the period, inclusive. Must be on or after date_from. Defaults to today.
  • customer_ids[] (array of integers): limit to these retailers (customer ids). Omit for every retailer.

Orders are counted by order date. An order is "shipped" at its first fulfilled shipment, and on time when that shipment left before the end of its ship-by day (tenant timezone).

Response data:

  • range: the resolved date_from / date_to.
  • totals: across all matched retailers — retailers, orders, shipped, on_time, on_time_pct (of shipped orders that have a ship-by date; null when none), avg_order_to_ship_hours, late, cancellations, avg_ship_to_tracking_hours.
  • retailers[]: one row per retailer with orders in the period — customer_id, retailer_name, orders, shipped, on_time, on_time_pct, avg_order_to_ship_hours, late (late_shipped + open_late), late_shipped (shipped after the ship-by day), open_late (not shipped, not cancelled and past the ship-by day), cancellations, avg_ship_to_tracking_hours (average hours from a shipment leaving to the retailer accepting its dropship_order.shipped webhook; null when the retailer takes no webhooks).
  • late_orders[]: up to 200 late orders, most overdue first — sales_order_id, sales_order_number, retailer_order_number, customer_id, retailer_name, order_date (ISO 8601 UTC), ship_by_date (Y-m-d), shipped_at (ISO 8601 or null), status (shipped_late or not_shipped), hours_late (hours past the end of the ship-by day, up to the shipment or now).

Errors: 422 when a date is not Y-m-d, date_to is before date_from, or a customer id is not an integer.

Request​

Responses​

OK

Response Headers
    Content-Type