WooCommerce · Schema

SalesReport

Aggregated sales report data for a time period.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name	Type	Description
total_sales	string	Total gross sales for the period.
net_revenue	string	Net revenue (gross sales minus refunds).
average_sales	string	Average daily sales for the period.
total_orders	integer	Total number of orders in the period.
total_items	integer	Total number of items sold.
total_tax	string	Total tax collected.
total_shipping	string	Total shipping revenue.
total_refunds	number	Total refund amount.
total_discount	number	Total discount amount.
totals_grouped_by	string	Grouping interval for totals_by_date (day, week, month, year).
totals	object	Sales totals grouped by the totals_grouped_by interval.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-sales-report-schema.json",
  "title": "SalesReport",
  "description": "Aggregated sales report data for a time period.",
  "type": "object",
  "properties": {
    "total_sales": {
      "type": "string",
      "description": "Total gross sales for the period.",
      "example": "string-value"
    },
    "net_revenue": {
      "type": "string",
      "description": "Net revenue (gross sales minus refunds).",
      "example": "string-value"
    },
    "average_sales": {
      "type": "string",
      "description": "Average daily sales for the period.",
      "example": "string-value"
    },
    "total_orders": {
      "type": "integer",
      "description": "Total number of orders in the period.",
      "example": 1
    },
    "total_items": {
      "type": "integer",
      "description": "Total number of items sold.",
      "example": 1
    },
    "total_tax": {
      "type": "string",
      "description": "Total tax collected.",
      "example": "string-value"
    },
    "total_shipping": {
      "type": "string",
      "description": "Total shipping revenue.",
      "example": "string-value"
    },
    "total_refunds": {
      "type": "number",
      "description": "Total refund amount.",
      "example": 10.5
    },
    "total_discount": {
      "type": "number",
      "description": "Total discount amount.",
      "example": 10.5
    },
    "totals_grouped_by": {
      "type": "string",
      "description": "Grouping interval for totals_by_date (day, week, month, year).",
      "example": "string-value"
    },
    "totals": {
      "type": "object",
      "description": "Sales totals grouped by the totals_grouped_by interval.",
      "additionalProperties": true,
      "example": {}
    }
  }
}