Install Jentic One Beta

Connect the MerchantFlow Public API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the MerchantFlow Public API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmerchantflow.ai%2Fmerchantflow" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmerchantflow.ai%2Fmerchantflow" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with MerchantFlow Public API.

Read the Marketing Efficiency Ratio for a from and to date window, computed as D2C gross revenue over deduplicated blended ad spend

Fetch D2C gross revenue, advertising spend, or contribution profit for a window as single figures

Sync orders incrementally with updated_after, including revenue, COGS, fees, profit, and cogs_coverage_pct per order

Filter orders by created_after, created_before, and sales_channel d2c or b2b, paging with limit and cursor

GET STARTED

Start building with MerchantFlow Public API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use MerchantFlow Public API for, with concrete tasks.

★ Agent-run weekly performance brief through Jentic

A founder's agent writes a Monday brief on how the store did last week. Through Jentic it reads MER, D2C gross revenue, and ad spend for the window, then contribution profit, and explains what moved. Because each metric has its own narrow scope, the merchant can approve just those figures, and the OAuth token stays in your own Jentic One instance rather than in the agent's context.

Call GET /metrics/mer, GET /metrics/revenue, GET /metrics/ad-spend, and GET /metrics/contribution-profit each with from '2026-11-02' and to '2026-11-08', and summarise the four figures

Incremental order economics sync

Finance and BI tools need per-order economics kept current. The orders endpoint takes updated_after and returns results oldest-change-first, including orders whose COGS, fulfilment cost, or attribution were corrected later, so the updated_at of the last processed record is a safe resume watermark. Each order carries cogs_coverage_pct, and ad_spend_allocated is a blended daily allocation rather than measured per-order spend.

Call GET /orders with updated_after '2026-11-08T00:00:00Z' and limit 250, follow the cursor until no more pages, and return orders whose cogs_coverage_pct is below 80

Daily profit and loss monitoring

Operators watch daily profit to catch problems early. The daily profitability endpoint returns a P&L series between start_date and end_date, and the summary endpoint returns the aggregate for a period, including COGS, expenses, and net profit. These need the broader profitability:read scope, so integrations that only need one figure should use the metrics endpoints instead.

Call GET /profitability/daily with start_date '2026-10-10' and end_date '2026-11-08', then flag any day where net profit was negative

Product cost review

Margin depends on accurate product costs. The products endpoint lists products with their current costs, filterable by status and pageable with limit and cursor, so an agent can spot products with missing or stale costs that would inflate order margins.

Call GET /products with limit 250, page through all results, and list products whose current cost is missing

Key Endpoints

12 endpoints — the merchantflow public api gives an authorised application read-only access to an e-commerce merchant's headline metrics, order economics, products, and profit and loss.

METHOD

PATH

DESCRIPTION

GET

/metrics/mer

Marketing Efficiency Ratio for a window

GET

/metrics/contribution-profit

Contribution profit for a window

GET

/orders

List orders with their economics

GET

/orders/{id}

Fetch one order

GET

/products

List products with current costs

GET

/profitability/summary

Aggregate profit and loss

GET

/profitability/daily

Daily profit and loss series

GET

/metrics/mer

Marketing Efficiency Ratio for a window

GET

/metrics/contribution-profit

Contribution profit for a window

GET

/orders

List orders with their economics

GET

/orders/{id}

Fetch one order

GET

/products

List products with current costs

GET

/profitability/summary

Aggregate profit and loss

GET

/profitability/daily

Daily profit and loss series

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring MerchantFlow by hand means running OAuth 2.1 with PKCE S256, sending the RFC 8707 resource indicator at authorize and token time, requesting offline_access for a refresh token, and asking for the right per-figure scope on each call. Through Jentic you install once, import MerchantFlow from the API Directory, store the OAuth credential once, and your agent calls it.

Permission scoping

Every MerchantFlow endpoint is a GET, so a Jentic rule bounds which reads your agent may call: the single-figure metrics, orders, products, or the full P&L. You choose the operations it may call, so order economics and the profitability waterfall are not included unless you add them.

Credential isolation

Your MerchantFlow OAuth token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'get marketing efficiency ratio' or 'sync changed orders', and Jentic returns the matching MerchantFlow operation with its input schema, including from, to, and updated_after, so the agent calls the right endpoint directly.

FAQs

Specific to using MerchantFlow Public API through Jentic.

What authentication does the MerchantFlow Public API use?

Per its OpenAPI spec, MerchantFlow uses OAuth 2.1 authorization code with PKCE (S256 required), with the RFC 8707 resource indicator sent at both the authorize and token endpoints. Each endpoint needs a specific scope, such as metrics:mer:read, orders:read, or profitability:read, and requesting offline_access returns a refresh token; without it the access token expires after one hour. Through Jentic the token is stored encrypted by your own Jentic One instance and injected at call time.

Can I sync only the orders that changed with the MerchantFlow API?

Yes. Pass updated_after to GET /orders and you receive only orders changed since then, including ones whose COGS, fulfilment cost, or attribution were corrected later. Results come oldest-change-first, so the updated_at of the last record you processed is a safe watermark, and limit (up to 250) with cursor pages through the rest.

What are the rate limits for the MerchantFlow Public API?

The OpenAPI spec does not specify rate limits. List endpoints accept a limit of up to 250 records per page. Check the MerchantFlow documentation at https://docs.merchantflow.ai/docs/integrations/api for current limits.

Is there a MerchantFlow MCP server?

You don't need an MCP server to give your agent MerchantFlow. Jentic connects it directly from the API Directory: import it, store your OAuth credential once, and your agent calls the metrics, orders, and profitability reads it needs on demand without loading another server's tool definitions into its context.

How do I read a store's MER through Jentic?

Search Jentic for 'get marketing efficiency ratio', load the GET /metrics/mer operation, and execute it with from and to dates. The mer value is D2C gross revenue divided by deduplicated blended ad spend, excludes wholesale revenue, and is null when no ad spend was recorded. To run it on your own infrastructure, install Jentic One from its GitHub repo.

Can I limit what my agent is allowed to do with the MerchantFlow API?

Yes. The API is already read-only, and you can go further: write a rule that allows only GET /metrics/mer and GET /metrics/revenue, so the agent can report the ratio and revenue but cannot read order economics or the full P&L. Every call it makes is logged.

Does the MerchantFlow API return customer personal data?

No. Customer names, email addresses, phone numbers, and shipping addresses are never returned. Orders carry customer_ref, a pseudonymous identifier that is stable for your application and one merchant and cannot be correlated with other applications' identifiers.

MerchantFlow Public API

AI ReadinessAI-Aware (A-)72/100

See full scorecard

Official vendor OpenAPI document · agent-readyAnalyticsBusiness Intelligenceoauth212 EndpointsREST

For Agents

Read a merchant's MER, revenue, ad spend, and contribution profit for a date range, sync orders with their per-order economics, list products with current costs, and pull aggregate or daily profit and loss, all read-only.

Use for: What was our MER last month, Get the contribution profit for Q3, I need to sync orders that changed since yesterday's run, List all B2B orders created in October

Not supported: Does not create or edit orders, products, or ad campaigns, and does not return customer contact details. Use for reading store metrics, order economics, product costs, and profit and loss only.

The MerchantFlow Public API gives an authorised application read-only access to an e-commerce merchant's headline metrics, order economics, products, and profit and loss. Single-figure endpoints return the Marketing Efficiency Ratio, D2C gross revenue, ad spend, or contribution profit for a date range, while the orders endpoint returns each order's revenue, COGS, fees, and profit with a cogs_coverage_pct and a pseudonymous customer_ref instead of customer PII. Profitability endpoints return an aggregate P&L and a daily series, and every call uses OAuth 2.1 with PKCE and narrow per-figure scopes such as metrics:mer:read.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A+Signals: 4

98%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

100%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B-Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

50%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: C-Signals: 4

49%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

52%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: A+Signals: 1

90%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: ASignals: 1

82%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the MerchantFlow Public API to your agent

Capabilities

Start building with MerchantFlow Public API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

MerchantFlow Public API

Jentic AI Readiness Score

MerchantFlow Public API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness