BAbagisto
Admin Reporting: Sales

Reporting — sales (View Details)

The detailed table form of a sales stat (the admin "View Details" page). statistics is { columns, records }. ?type= chooses the stat group.

get/reporting/sales/view

Request

Query parameters

type'total-sales' | 'average-sales' | 'total-orders' | 'purchase-funnel' | 'abandoned-carts' | 'refunds' | 'tax-collected' | 'shipping-collected' | 'top-payment-methods' | 'sales-by-coupon'

Stat group.

startstring date

Start date.

endstring date

End date.

channelstring

Channel code.

Response

AdminReportingSales collection

entitystring nullable
typestring nullable
statisticsobject nullable

Example response

[
  {
    "statistics": {
      "sales": {
        "previous": 27178.38,
        "current": 9697.53,
        "formatted_total": "$9,697.53",
        "progress": -64.32
      },
      "over_time": {
        "previous": [
          {
            "label": "10 Apr",
            "total": "8526.82",
            "count": 12
          }
        ],
        "current": [
          {
            "label": "10 May",
            "total": "8500.00",
            "count": 12
          }
        ]
      }
    }
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.