Skip to main content

SalesSummary

How a merchant sold over a period: the headline figures a dashboard shows, and the same figures broken down by selling surface.

type SalesSummary {
  period: DateRange!
  revenue: Money!
  refundedAmount: Money!
  netRevenue: Money!
  orderCount: Int!
  refundedOrderCount: Int!
  averageOrderValue: Money!
  refundRate: Float!
  channels: [ChannelSummary!]!
}

Fields​

SalesSummary.period ● DateRange! non-null object​

The span of days these figures cover.

SalesSummary.revenue ● Money! non-null object​

What the period's orders came to before refunds, in the merchant's currency.

SalesSummary.refundedAmount ● Money! non-null object​

How much of that revenue has been refunded to customers.

SalesSummary.netRevenue ● Money! non-null object​

What the merchant kept: revenue less refunds.

SalesSummary.orderCount ● Int! non-null scalar​

How many orders the merchant took in the period, cancellations excluded.

SalesSummary.refundedOrderCount ● Int! non-null scalar​

How many of those orders were refunded in whole or in part.

SalesSummary.averageOrderValue ● Money! non-null object​

Revenue divided by order count, rounded to the nearest minor unit. Zero when the period took no orders. Because it is rounded, multiplying it back by the order count can differ from revenue by a few minor units.

SalesSummary.refundRate ● Float! non-null scalar​

The share of the period's orders that were refunded, as a fraction between 0 and 1. Zero when the period took no orders.

SalesSummary.channels ● [ChannelSummary!]! non-null object​

The same period, one entry per selling surface that took an order. A channel with no orders in the period is absent rather than reported as zero.

Returned By​

salesSummary query