Skip to main content

customerMetrics

Returns order counts, net merchandise sales and average order value for one customer over the last twelve calendar months, with its first and last order across all history.

Business Rules​

  • Ordered, allocated, in-progress, held, partially shipped and shipped orders qualify, including the equivalent historical accepted and completed states.
  • Archived orders and archived order lines are excluded.
  • Sales are line prices times quantities less line discounts, excluding shipping and tax.
  • Months and their boundaries follow the company timezone.
  • Channel activity reports only the months that have qualifying orders.

Error Scenarios​

  • The customer does not exist.

Permissions Required​

  • customers:read_customer
customerMetrics(
  customerId: ID!
): CustomerMetrics!

Arguments​

customerMetrics.customerId ● ID! non-null scalar common​

The customer to report on.

Type​

CustomerMetrics object common​

Order metrics for this customer only, excluding archived orders. Ordered, allocated, in-progress, held, partially shipped and shipped orders qualify, including equivalent historical accepted and completed states.