API reference

Reports

Sales figures.

Sales report

get/reports/sales

Dates are days in the store's time zone; at most 2 years. Default: the last 30 days.

Required scopes:read_reports

Query parameters

Name	Type	Description
`from`	string<date>	First day (YYYY-MM-DD).
`to`	string<date>	Last day, inclusive (YYYY-MM-DD).
`interval`	string	Rows per day, week or month (default by range length). One of:`dayweekmonth`

Example request

curl

curl "https://api.sellorchard.com/v1/reports/sales" \
  -H "Authorization: Bearer $SELLORCHARD_API_KEY"

Response200The sales report.

Show response schema

dataSalesReportrequired
Test and cancelled orders are left out.
ShowHide child attributes
- objectstringrequired
- fromstring<date>required
  First day (store time zone).
- tostring<date>required
  Last day (inclusive).
- intervalstringrequired
  Row grouping.
  One of:dayweekmonth
- timezonestringrequired
  Store time zone.
- currencystringrequired
  Store currency (orders in other currencies are converted).
- totalsSalesReportRowrequired
  ShowHide child attributes
  periodstring<date>
  First day of the period (store time zone); totals have none.
  gross_salesstring
  Goods sold.
  pattern ^-?\d+\.\d{2}$
  discountsstring
  Discounts.
  pattern ^-?\d+\.\d{2}$
  returnsstring
  Refunds.
  pattern ^-?\d+\.\d{2}$
  net_salesstring
  Gross − discounts − returns.
  pattern ^-?\d+\.\d{2}$
  shippingstring
  Shipping.
  pattern ^-?\d+\.\d{2}$
  taxesstring
  Taxes.
  pattern ^-?\d+\.\d{2}$
  total_salesstring
  Net + shipping + taxes.
  pattern ^-?\d+\.\d{2}$
  ordersinteger
  Orders.
  unitsinteger
  Units.
  aovstring
  Average order value.
  pattern ^-?\d+\.\d{2}$
  gift_cards_soldstring
  Gift cards sold.
  pattern ^-?\d+\.\d{2}$
  coststring
  Cost of goods.
  pattern ^-?\d+\.\d{2}$
  profitstring
  Net − cost.
  pattern ^-?\d+\.\d{2}$
  marginnumber | null
  Profit / net sales, percent.
- rowsarray of SalesReportRowrequired
  One per period.
  ShowHide item attributes
  periodstring<date>
  First day of the period (store time zone); totals have none.
  gross_salesstring
  Goods sold.
  pattern ^-?\d+\.\d{2}$
  discountsstring
  Discounts.
  pattern ^-?\d+\.\d{2}$
  returnsstring
  Refunds.
  pattern ^-?\d+\.\d{2}$
  net_salesstring
  Gross − discounts − returns.
  pattern ^-?\d+\.\d{2}$
  shippingstring
  Shipping.
  pattern ^-?\d+\.\d{2}$
  taxesstring
  Taxes.
  pattern ^-?\d+\.\d{2}$
  total_salesstring
  Net + shipping + taxes.
  pattern ^-?\d+\.\d{2}$
  ordersinteger
  Orders.
  unitsinteger
  Units.
  aovstring
  Average order value.
  pattern ^-?\d+\.\d{2}$
  gift_cards_soldstring
  Gift cards sold.
  pattern ^-?\d+\.\d{2}$
  coststring
  Cost of goods.
  pattern ^-?\d+\.\d{2}$
  profitstring
  Net − cost.
  pattern ^-?\d+\.\d{2}$
  marginnumber | null
  Profit / net sales, percent.

200 response

{
  "data": {
    "object": "sales_report",
    "from": "2026-11-01",
    "to": "2026-11-07",
    "interval": "day",
    "timezone": "America/Chicago",
    "currency": "USD",
    "totals": {
      "period": "2026-11-01",
      "gross_sales": "1250.00",
      "discounts": "80.00",
      "returns": "0.00",
      "net_sales": "1170.00",
      "shipping": "60.00",
      "taxes": "96.53",
      "total_sales": "1326.53",
      "orders": 24,
      "units": 51,
      "aov": "55.27"
    },
    "rows": [
      {
        "period": "2026-11-01",
        "gross_sales": "1250.00",
        "discounts": "80.00",
        "returns": "0.00",
        "net_sales": "1170.00",
        "shipping": "60.00",
        "taxes": "96.53",
        "total_sales": "1326.53",
        "orders": 24,
        "units": 51,
        "aov": "55.27"
      }
    ]
  }
}

Error responses

401authenticationMissing, invalid, expired or revoked API key.
403permissionThe key lacks the scope, or the store's plan doesn't include the API.
422invalid_requestInvalid parameters; errors lists each field.
429rate_limitedToo many requests.
500serverSomething went wrong on our side; safe to retry with the same Idempotency-Key.