ordersReport Query

Description

Generates a comprehensive sales report for filtered orders, including financial totals, payment method statistics, and item breakdowns. The report excludes cancelled, refunded, and merged orders. Only accessible to admin users.

query ordersReport($ordersFiltersInput: OrdersFiltersInput!) {
  ordersReport(ordersFiltersInput: $ordersFiltersInput) {
    totals {
      grand
      subtotal
      subtotalBeforeTaxes
      shippingBeforeTaxes
      secondHandProfit
    }
    paymentMethods {
      origin
      total
      count
    }
    items {
      count
      news
      secondHands
      books
      products
      giftCards
    }
  }
}

Variables

{
    "ordersFiltersInput": {
        "page": 1,
        "limit": 20,
        "sort": "sort",
        "order": 42,
        "from": 1726572334942,
        "to": 1751496574870,
        "dateFilter": "dateFilter",
        "origin": [
            "origin"
        ],
        "status": [
            "status"
        ],
        "billingStatus": [
            "billingStatus"
        ],
        "shippingStatus": [
            "shippingStatus"
        ],
        "paymentMethods": [
            "paymentMethods"
        ],
        "itemRef": "106171210aca75f090be3f32",
        "buyerRef": "8b82f57c79221d54b8dbbb5d",
        "couponRef": "3f898ba2f232dc36e4aea386",
        "giftCardRef": "d31373671c8aef6acc5443bd",
        "term": "term"
    }
}

Response

{
    "ordersReport": {
        "totals": {
            "grand": 1.23,
            "subtotal": 1.23,
            "subtotalBeforeTaxes": 1.23,
            "shippingBeforeTaxes": 1.23,
            "secondHandProfit": 1.23
        },
        "paymentMethods": [
            {
                "origin": "example",
                "total": 29.99,
                "count": 10
            }
        ],
        "items": {
            "count": 10,
            "news": 1.23,
            "secondHands": 1.23,
            "books": 1.23,
            "products": 1.23,
            "giftCards": 1.23
        }
    }
}

Arguments

Name	Type	Description
ordersFiltersInput	OrdersFiltersInput!	Input type. See the OrdersFiltersInput type for field details.

Returns

OrdersReport!