Insights

Daily order statistics per store: counts, delivery-type splits, revenue (incl. and excl. VAT), and orders-by-status.

post/api/Insights/Orders

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Insights/Orders
  • Auth: API key in header Authorization

Request body

fromDatestring date-time

Start of the date range (inclusive), in the tenant's timezone.

toDatestring date-time

End of the date range (inclusive), in the tenant's timezone.

storeIdstring nullable

Optional internal Omnium store ID to filter results to a single store.

Response

Success

datestring nullable

The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.

storeIdstring nullable

The internal Omnium store ID.

storeNamestring nullable

The store name at the time of aggregation.

totalOrdersinteger

Number of unique orders for this (date, store). Counts original sales only — excludes ReturnOrder and Replacement order types.

clickAndCollectOrdersinteger

Number of unique orders with OrderType in {ClickAndCollect, Bopis}.

homeDeliveryOrdersinteger

Number of unique orders with OrderType in {Online, ShipFromStore}.

totalRevenuenumber

Sum of order-line ExtendedPrice (incl. VAT). Excludes shipping and order-level surcharges.

totalRevenueExclVatnumber

Sum of order-line ExtendedPriceExclTax (excl. VAT). Excludes shipping and order-level surcharges.

averageCartValuenumber

TotalRevenue divided by TotalOrders for this bucket.

Changes

No recorded changes to this operation across all 1 revision of this API.