Delivery routes
Own fleet vs courier over the last 30 or 90 days, from the snapshots stored when routes were completed: totals, saving, verdict counts, hybrid saving, CO2, break-even stop count and the routes that lost money. (scope: delivery:read)
GET
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
window?stringLook-back window in days
Default
"30"Value in
"30""90"mode?stringmarginal (default) or full (adds depreciation and insurance)
Default
"marginal"Value in
"marginal""full"OK
application/json- response
data*Own fleet vs courier over the last 30 or 90 days, from the cost snapshots stored when each route was completed (F-VS). Every *Minor amount is an integer in minor units of currency.
error*nullcurl -X GET "https://example.com/delivery-routes/cost-analytics"{ "data": { "windowDays": 30, "mode": "MARGINAL", "currency": "string", "routes": 0, "comparableRoutes": 0, "fleetMinor": 0, "courierMinor": 0, "savingMinor": 0, "verdicts": { "FLEET": 0, "COURIER": 0, "TIE": 0, "UNKNOWN": 0 }, "hybridSavingMinor": 0, "co2Grams": 0, "avgStops": 0, "breakEvenStops": 0, "estimatedPercent": 0, "losing": [ { "routeId": "fef0741a-9185-417e-be48-b4fe23a36919", "number": "string", "name": "string", "routeDate": "2019-08-24T14:15:22Z", "fleetMinor": 0, "courierMinor": 0, "lossMinor": 0 } ] }, "error": null}