Orders statistics

Retrieve all

GET https://in.tasbud.com/api/orders-statistics/
curl --request GET \
--url 'https://in.tasbud.com/api/orders-statistics/?type=overview&start_date=2020-01-01&end_date=2021-01-01' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
start_date Optional String Start date in Y-m-d format. Defaults to 30 days ago if omitted.
end_date Optional String End date in Y-m-d format. Defaults to today if omitted.
store_id Optional Integer
menu_id Optional Integer
category_id Optional Integer
type Optional String Allowed values: overview, items, categories, menus, order_types, payment_processors, weekdays, hours, basket_size 
{
    "data": {
        "statistics": {
            "orders": 25,
            "ordered_items": 75,
            "value": 1250.5,
            "average_order_value": 50.02,
            "average_ordered_items": 3,
            "pending_orders": 5
        },
        "chart": [
            {
                "ordered_items": 30,
                "value": 500.25,
                "formatted_date": "2021-01"
            },
            {
                "ordered_items": 45,
                "value": 750.25,
                "formatted_date": "2021-02"
            }
        ]
    }
}

Retrieve one

GET https://in.tasbud.com/api/orders-statistics/{store_id}
Parameters Details Description
start_date Optional String Start date in Y-m-d format. Defaults to 30 days ago if omitted.
end_date Optional String End date in Y-m-d format. Defaults to today if omitted.
type Optional String Allowed values: overview, items, categories, menus, order_types, payment_processors, weekdays, hours, basket_size
curl --request GET \
--url 'https://in.tasbud.com/api/orders-statistics/{store_id}?type=items&start_date=2020-01-01&end_date=2021-01-01' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": [
        {
            "item_id": 10,
            "name": "Cheeseburger",
            "orders": 20,
            "value": 300
        },
        {
            "item_id": 15,
            "name": "Lemonade",
            "orders": 12,
            "value": 48
        }
    ]
}