API Reference
  1. Analify Analytics API
  2. Shipping / Bosta

Shipping cod settlement

get
https://analify.scalyax.ai/api/analytics/integration//rich/shipping-cod-settlement

COD settlement: aging buckets, settlement timeline, plus the COD Analysis model (codAnalysisModel — COD by city, payment split, COD flow).

  • CACHED: this route wraps its live fetch in a short read-through response cache — 60s when the range includes today, 300s when the range is fully in the past.
  • Entries always expire and re-fetch live; a fetch failure never falls back to a cached value.
  • Polling faster than once a minute returns the identical body.
  • Money fields are integer piasters (EGP x 100).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The integration UUID. Discover it with GET /api/core/integrations.

Query Params
uuid
required

The organization to read. Required on EVERY endpoint, even when the path already carries an org slug or integration id.

date
required

Start of the window, YYYY-MM-DD, inclusive.

date
required

End of the window, YYYY-MM-DD, inclusive.

string
enum

Set to true to bundle the prior period into one response as { current, previous }. Never call the endpoint twice.

Allowed:
date

Explicit start of the comparison window. Defaults to the same-length preceding period.

date

Explicit end of the comparison window.

Responses
200

OK

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
anlfy_...
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?