Skip to main content

ordersSummary

Returns the units ordered across the orders that match the filters. It accepts the same filters as the orders query, so the number describes the same orders the list returns, and totalCount of that query gives how many they are.

Business Rules​

  • totalUnits adds up stats.totalUnits of each matching order. Shipping an order does not change it.
  • Sort filters do not change the result.

Error Scenarios​

  • One or more brand IDs are not valid UUIDs.

Permissions Required​

  • get_orders
ordersSummary(
  filters: OrderFilterInput
): OrdersSummary!

Arguments​

ordersSummary.filters ● OrderFilterInput input orders​

Filtering options for orders, the same as the orders query.

Type​

OrdersSummary object common​

Totals for the orders that match a set of filters.