iRetail PRO hub 1.0.0-m5

organization 2 operations

The chain.

• GET /v1/organization The chain this hub serves.
• PATCH /v1/organization Change the chain's name or default language.

stores 19 operations

The chain's stores and their prices.

• GET /v1/stores The chain's stores with the state of their nodes.
• POST /v1/stores Add a store; its node registers with a token made for it.
• GET /v1/stores/{id} One store with the state of its node.
• PATCH /v1/stores/{id} Change a store's settings; they reach its node as a record.
• PUT /v1/stores/{id}/register-share Give a store its share of the license's registers; it reaches the store with its record.
• GET /v1/stores/{id}/tax-rates A store's tax codes (spec/TAX.md).
• PUT /v1/stores/{id}/tax-rates/{code} Create or change one store's tax code; it reaches the store as a record.
• DELETE /v1/stores/{id}/tax-rates/{code} Delete a store's tax code that no item of the store uses.
• GET /v1/stores/{id}/tax-provider Where a store's tax rates come from, and how the last sync went (spec/TAX.md).
• PUT /v1/stores/{id}/tax-provider Set the tax service that fills a store's rates; the key is only named.
• POST /v1/stores/{id}/tax-provider/sync Ask the tax service for a store's rates now; answers the status after the attempt.
• GET /v1/stores/{id}/deposits A store's container deposits (spec/TAX.md).
• PUT /v1/stores/{id}/deposits/{code} Create or change one store's container deposit; it reaches the store as a record.
• DELETE /v1/stores/{id}/deposits/{code} Delete a store's deposit that no item names.
• GET /v1/stores/{id}/prices A store's prices by item.
• PUT /v1/stores/{id}/prices/{item_id} Set an item's price in one store; it reaches the store as a record.
• GET /v1/transfers The chain's transfers with both documents (spec/STOCK.md, Transfers).
• GET /v1/transfers/{id} One transfer of the chain.
• GET /v1/stock/in-transit Every line in transit between the chain's stores.

nodes 4 operations

Store nodes registered with the hub.

• POST /v1/stores/{id}/registration-tokens A one-time token a store's node registers with (spec/SYNC.md, Registration); shown once.
• GET /v1/nodes Registered store nodes and their sync state.
• GET /v1/nodes/{id} One node and its sync state.
• POST /v1/nodes/{id}/revoke Refuse the node's certificate from now on; the store keeps selling, cut off from the hub.

change-requests 3 operations

Stores' requests for hub-owned changes.

• GET /v1/change-requests Stores' change requests, pending first.
• POST /v1/change-requests/{id}/approve Make the proposed record the hub's (same id); it reaches every store it concerns.
• POST /v1/change-requests/{id}/refuse Refuse a request with a reason the store sees.

analytics 8 operations

The chain's sales and stock (spec/ANALYTICS.md).

• GET /v1/analytics/metrics The metrics the analytics query offers (metrics/catalog.json).
• POST /v1/analytics/query The chain's sales and stock by the metrics and dimensions asked (spec/ANALYTICS.md).
• GET /v1/exchange-rates The organization's exchange rates by day, newest first (spec/ANALYTICS.md, Currencies).
• PUT /v1/exchange-rates/{date}/{from}/{to} Set the rate of a day for a pair.
• DELETE /v1/exchange-rates/{date}/{from}/{to} Remove the rate of a day for a pair.
• POST /v1/exchange-rates/import Import rates from CSV: a header date,from,to,rate, then one rate per line.
• GET /v1/reports/bonuses Employee bonuses over the chain's stores, by store and employee.
• GET /v1/reports/partners Partners over the chain's stores, by store and partner.

dashboards 4 operations

Pages of tiles over the analytics (spec/DASHBOARDS.md).

• GET /v1/dashboards The organization's dashboards and the ready-made set (spec/DASHBOARDS.md).
• GET /v1/dashboards/{id} One dashboard.
• PUT /v1/dashboards/{id} Save a dashboard; under a ready-made id, the organization's copy takes its place.
• DELETE /v1/dashboards/{id} Delete the organization's dashboard (a ready-made one comes back in its place).

network 4 operations

The chain's private WireGuard network (spec/NETWORK.md).

• PUT /v1/stores/{id}/network The store's own switch for the private network (spec/NETWORK.md); null follows the organization. It reaches the store with its record.
• GET /v1/network The organization's private network (spec/NETWORK.md).
• PUT /v1/network Turn the private network on or off, set its subnet (only while off) and the endpoint stores reach the hub at.
• GET /v1/network/peers Every registered node as a peer of the hub, with its latest handshake as the replicas recorded it.

releases 22 operations

Releases the hub holds, rollouts in waves and the hub's own update (spec/RELEASES.md).

• GET /v1/releases The releases the hub holds, the latest version first (spec/RELEASES.md, The hub's releases).
• GET /v1/releases/available What the source (IRETAIL_RELEASES_URL) offers as its latest release, and whether the hub holds it. 409 release_source_missing with downloading off, 503 release_source_unreachable when version.json cannot be read.
• POST /v1/releases/download Download a release from the source. The manifest is read and verified before answering (422 release_refused); the artifacts follow in the background, each verified as it is stored. 200 for a version already held.
• POST /v1/releases/import Import a release bundle sent as the raw body (a POSIX tar, manifest.json first, then every artifact). Verified as it streams; 201 verified, 200 for the same manifest again, 409 release_conflict for another manifest of a version held, 422 release_refused with nothing kept.
• GET /v1/releases/{version} One release the hub holds, with its signed manifest.
• DELETE /v1/releases/{version} Remove a release and its files from storage; 409 release_in_use while it is in use.
• GET /v1/rollouts Rollouts, newest first (spec/RELEASES.md, Rollouts).
• POST /v1/rollouts Start a rollout of a verified release in waves. 409 rollout_active while another is unfinished; 422 invalid_rollout with a reason.
• GET /v1/rollouts/{id} One rollout with its waves.
• GET /v1/rollouts/{id}/stores Each store of a rollout with its wave, update state and gate status, in the waves' order.
• POST /v1/rollouts/{id}/pause Pause a running rollout; the current wave's stores that have not begun applying lose their targets. 409 rollout_state otherwise.
• POST /v1/rollouts/{id}/resume Resume a paused rollout on its current wave, as a new attempt for the stores not done; the current wave's stores whose apps are held for the release have the hold cleared (apps_cleared_at). 409 rollout_state otherwise.
• POST /v1/rollouts/{id}/rollback Send every store that took the release back to its previous version, at once. 409 rollout_state from rolling_back or rolled_back, 409 rollout_not_latest for an older rollout, 409 rollout_active while another is unfinished.
• POST /v1/rollouts/{id}/stores/{store_id}/skip Take a store out of a rollout; a target it has not finished is withdrawn and the gate passes it. 409 rollout_state in completed or rolled_back.
• POST /v1/rollouts/{id}/stores/{store_id}/clear-apps Clear a store's held apps for the rollout's release (spec/RELEASES.md, One device first) by writing its target again with apps_cleared_at. 409 rollout_state in rolled_back; 404 for a store the rollout does not cover or whose target was withdrawn.
• GET /v1/app-update What an app of the hub's office store, or the console on a desktop, should run, by the release the hub runs, one device first (spec/RELEASES.md, The apps); as a store's getAppUpdate. A hub that does not hold the release it runs offers no installer.
• POST /v1/app-update/report An app of the hub's office store, or the console, reports where its update stands (spec/RELEASES.md, Reporting); as a store's postAppUpdateReport.
• POST /v1/app-update/clear Clear the hub's office store's hold of a release for an app and platform (spec/RELEASES.md, One device first). 404 when nothing is held.
• GET /v1/releases/{version}/manifest The signed manifest of a release the hub holds verified, for its office store's devices, the console and its updater; the caller verifies it with its own embedded keys. 404 for a release not held or not verified.
• GET /v1/releases/{version}/artifacts/{name} A file of a release the hub holds verified; Range resumes a broken download. The caller checks its size and SHA-256 against the manifest.
• GET /v1/hub-update The hub's own update (spec/RELEASES.md, The hub's own update).
• PUT /v1/hub-update Set the hub's own target, applied by its updater. 404 for a version not held, 409 release_not_verified, 409 stores_incompatible unless forced, 422 release_refused (downgrade) for an earlier version that is not the previous one.

brand 3 operations

Stores' banners over the organization's brand (spec/BRANDS.md); the brand itself is the store API's.

• GET /v1/stores/{id}/banner A store's banner over the brand, served whether or not the key holds white_label; 404 when the store has none (spec/BRANDS.md).
• PUT /v1/stores/{id}/banner Set a store's banner, checked as a brand is (422 invalid_brand, 422 brand_contrast); 403 module_disabled without white_label.
• DELETE /v1/stores/{id}/banner Remove a store's banner, bringing the brand back to it; 403 module_disabled without white_label.

alerts 4 operations

• GET /v1/alerts The chain's alerts, newest first (spec/HEALTH.md).
• POST /v1/alerts/{id}/acknowledge Acknowledge an open alert; it stays open and sends no further notice. 409 alert_resolved for one already resolved.
• GET /v1/alerts/settings The alert thresholds and the webhook's name.
• PUT /v1/alerts/settings Set the alert thresholds and the webhook's name (its URL is read from IRETAIL_ALERT_WEBHOOK_<NAME>).

backups 5 operations

• GET /v1/backup-policy The organization's backup policy (spec/BACKUP.md).
• PUT /v1/backup-policy Set the backup policy; it reaches every store with its record. 409 backup_storage_missing to enable it without storage at the hub.
• GET /v1/backups Stored and failed archives, newest first.
• POST /v1/backups Ask a store (or the hub) for an archive now. 409 backup_disabled without an enabled policy.
• GET /v1/backups/{id}/download The encrypted archive, with its file name; only the organization's age identities open it.