Insights

Daily return statistics per store: return count, pro-rated return value, and return rate against orders created on the same day.

post/api/Insights/Returns

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/Returns
  • 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 for the original order.

returnCountinteger

Number of unique returns (by ReturnOrder.ReturnOrderId) on this day.

returnValuenumber

Sum of pro-rated returned line value (ReturnQuantity / Quantity × ExtendedPrice), incl. VAT, absolute value.

returnRatenumber

ReturnCount divided by the number of orders created on the same day. This is a simplification — a return may reference an order from a different day.

Changes

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