canonical: https://jentic.com/apis/mycashflow.fi/mycashflow # Mycashflow Fi MyCashflow API Jentic publishes the only available OpenAPI specification for MyCashflow API, keeping it validated and agent-ready. The MyCashflow API exposes the storefront, catalog, and operations resources of the MyCashflow Finnish e-commerce platform. It covers products, categories, brands, banners and banner groups, customers, orders, payments, shipments, and stock, each with full create-read-update-delete coverage. The 55 endpoints together cover the day-to-day operations of running a MyCashflow store. ## For AI agents Manage MyCashflow products, orders, customers, categories, banners, brands, payments, shipments, and stock through 55 CRUD operations. Returns store data scoped to the authenticated tenant. ## Scope Does not handle marketing automation, accounting, or fulfillment carrier integration directly - use for MyCashflow store catalog, order, customer, and storefront operations only. ## Capabilities - Manage the product catalog including titles, prices, and category links - Browse and update categories and brands that organize products - Read and update orders through their lifecycle including payments and shipments - Manage customer records and link them to orders - Configure banners and banner groups for storefront merchandising - Adjust stock levels for product variants - Read and create payments and shipments associated with orders ## Use cases ### Catalog Sync from a PIM Sync a product catalog from an upstream Product Information Management system into MyCashflow on a schedule. The integration pages through GET /products, then issues POST or PATCH calls per product to create or update entries; brands and categories are synced via the parallel /brands and /categories endpoints. With 55 CRUD endpoints, the full storefront data model can be kept in lockstep with the PIM. Example prompt: For each product changed in the PIM, call PATCH `/products/{id}` or POST /products, then verify with GET `/products/{id}` that the update succeeded. ### Order Fulfillment Pipeline Move new MyCashflow orders into a warehouse fulfillment pipeline and write back shipment data. The integration polls GET /orders for new entries, posts shipment records to /shipments as packages leave the warehouse, and updates payment status via /payments. This automates the manual order-handling clicks that small store operators traditionally do in the admin UI. Example prompt: Poll GET /orders for status=new, then for each order call POST /shipments to record dispatch and PATCH `/orders/{id}` to mark it as shipped. ### Inventory Reconciliation Reconcile stock levels in MyCashflow against the warehouse system of truth. The integration lists stock entries via GET /stock and issues PATCH calls to bring MyCashflow's quantity into agreement with the warehouse count. This prevents oversells when the warehouse and storefront drift apart. Example prompt: For each SKU in the warehouse export, call PATCH `/stock/{id}` with the corrected quantity if it differs from the warehouse count. ### Storefront Merchandising Updates Schedule banner and banner-group updates for promotions without logging into the MyCashflow admin. The /banners and /banner-groups endpoints expose CRUD over the merchandising surface, so a marketing scheduler can swap creative assets and target groups on a calendar. This decouples the marketing calendar from manual store ops. Example prompt: On the promotion start date, PATCH `/banners/{id}` to set the new image URL and PATCH `/banner-groups/{id}` to enable the group. ### AI Agent Store Operations Assistant Wire a Jentic-driven assistant that handles routine store operations on natural-language requests. The agent searches Jentic for 'create a product' or 'list recent orders', loads the matching MyCashflow operation, and executes it. Jentic injects the basic auth credentials at execution time so the agent never holds the store's password. Example prompt: Through Jentic, search for 'create a MyCashflow product', load POST /products, and create a new product with the title, price, and category provided in the user request. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/products` | List products | | POST | `/products` | Create a product | | GET | `/orders` | List orders | | GET | `/customers` | List customers | | GET | `/categories` | List categories | | GET | `/brands` | List brands | | GET | `/stock` | List stock entries | | GET | `/banners` | List banners | ## Key resources - **Products** — Manage the product catalog - **Categories** — Manage category hierarchy and product assignment - **Brands** — Manage brand records - **Customers** — Manage customer records - **Orders** — Read and update orders through their lifecycle - **Payments** — Manage payment records associated with orders - **Shipments** — Manage shipment records associated with orders - **Stock** — Adjust stock levels for product variants - **Banners and Banner Groups** — Manage storefront merchandising banners ## Why Jentic - **Setup:** Wiring the MyCashflow API by hand means handling its basic auth and substituting your store name into the {storeName}.mycashflow.fi host on every call yourself. Through Jentic you install once, import the MyCashflow API from the API Directory, store the basic credentials once, and your agent calls it. - **Permission scoping:** Catalog and order targets travel in the request body or query, so limit the agent to the operations it needs, such as listing orders or reading stock. You choose which operations are in scope, so a write call like creating a product is not included unless you add it. - **Credential handling:** Your MyCashflow basic credentials and store-specific host are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list store orders' or 'create a product', and Jentic returns the matching MyCashflow operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify Admin API** — Shopify is the dominant global alternative for hosted online stores with a much broader API surface. - **Magento (Adobe Commerce) API** — Magento is an enterprise self-hosted e-commerce alternative with similar catalog and order coverage. - **Ecwid API** — Ecwid is another hosted small-business e-commerce platform with a comparable resource model. ## FAQ ### Why is there no official OpenAPI spec for MyCashflow API? MyCashflow does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call MyCashflow API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the MyCashflow API use? MyCashflow uses HTTP basic authentication with a store-specific username and password issued from the MyCashflow admin. The base URL embeds the store name (https://{storeName}.mycashflow.fi/api/v1). Through Jentic, basic auth credentials are stored in the vault and applied at execution time. ### Can I create products via the MyCashflow API? Yes. POST /products creates a new product, PATCH `/products/{id}` updates one, and DELETE `/products/{id}` removes it. The same pattern is exposed for brands, categories, customers, orders, payments, shipments, banners, and stock. ### How do I list new orders through Jentic? Through Jentic, search for 'list MyCashflow orders', load GET /orders, and call it with the desired filter parameters. Jentic forwards the basic auth header from its vault and returns the order list to your agent. ### What are the rate limits for the MyCashflow API? Rate limits are enforced at the gateway and not declared in the OpenAPI spec. Stagger bulk syncs and respect 429 responses; for catalog updates, batch by category or brand to avoid hammering the storefront database. ### Can I adjust stock via the MyCashflow API? Yes. The /stock endpoints expose CRUD over stock entries, so an agent or scheduled job can keep MyCashflow stock counts in sync with a warehouse system using PATCH `/stock/{id}.` ### Can I limit what my agent is allowed to do with the MyCashflow API? Yes. Because Jentic One is self-hosted, you decide which of the 55 MyCashflow operations your agent can call, and your own rules set that scope. You can allow read-only calls such as listing orders with GET /orders or reading stock with GET /stock while leaving out write operations like POST /products or PATCH `/stock/{id}`, since those are only in scope if you add them. Your MyCashflow basic credentials and store-specific host are held by your own instance and injected at execution time, so the agent never sees them.