ILS), as JSON numbers with at most two decimals, never agorot. Show each figure with its own meaning: they do not add up to one another. You need money:read.
Read your balance
Earnings are available only while their order is delivered. If a delivered order moves on, for example to a ticket or an exchange, its earnings wait in
under_review until it is delivered again. A charge always counts at once.
List movements
GET /api/v1/ledger?page=1&limit=50 lists every movement, newest first. limit is 50 by default, at most 100.
Fetch statements
GET /api/v1/statements lists closed statements, newest first: number, period_start (inclusive), period_end (exclusive), opening, closing and finalized_at. GET /api/v1/statements/{statement_number} adds movements, oldest first, paged like GET /ledger. A number that is not yours answers 404 statement_not_found.
opening and closing include held earnings, so they are not amounts that could be paid out.
When the balance cannot be read
Every money read answers503 ledger_unavailable, with no Retry-After, never zeros or an empty list.
- Show that the balance is unavailable, never a figure you did not get.
- Retry later with backoff.
money.availableonGET /api/v1/accountstill answers200.
200 with zeros and empty lists.
Order totals report
GET /api/v1/reports/summary?months=6 (scope reports:read) totals your orders over 3, 6 or 12 months, 12 by default, counting the current month. Any other value, 03 included, answers 422 invalid_parameter.
order_count,order_valueandaverage_order_valueover the range.by_month, newest first:month,orders,value,cod_orders,card_ordersandcancelled. Months are in the shop’s local time.top_products: up to 10, withproduct_id,combination_id,name,quantityandorders.
