HomeGuidesAPI Reference
API Reference

Returns orders by store

get
https://api.flipdish.co/reporting/v1.0//order/store

By passing in the appropriate query, you can receive filtered and paginated
order statistics by store

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string | null
required

App Name Id

Query Params
string
enum

Defines granularity of the graph

DeliveryType
array of objects | null

Query delivery type/s

DeliveryType
Allowed:
Platform
array of objects | null

Query platform/s

Platform
StoreId
array of int32s | null

Query store/s

StoreId
string
enum

The period type, for custom period Start and End must be specified

date-time | null

Start Time of the period

date-time | null

End time of the period

string
enum

The period type, for custom period Start and End must be specified

Allowed:
date-time | null

Start Time of the period

date-time | null

End time of the period

VoucherCodes
array of strings | null

Query voucher code/s

VoucherCodes
PaymentType
array of strings | null

Query payment type/s

PaymentType
DeliveryZones
array of int32s | null

Delivery Zones filter

DeliveryZones
string | null

Currency filter (ISO 4217:2015)

string | null

User TImezone (IANA)

string | null

Sort By:
* orderAmount Order amount
* acceptedOrders Accepted orders count
* averageOrderSize: Average order size
* rejectedOrders: Rejected order count
* rejectedOrderAmount: Rejected order amount
* refundedOrders: Refunded order count
* refundedOrderAmount: Refunded order amount

string
enum

Sort Direction: Asc / Desc

Allowed:
boolean
Defaults to false

Will export the file as a CSV to your registered Email Address

int32
Defaults to 0

Pass an optional minutes to be added to offset the users timezone

Responses

400

Incorrect input

500

An irrecoverable error occured

Updated about 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago