Know of an official OpenAPI document? Contribute it →
For Agents
List and read marketplace orders, advance them through cancel, delivery, retrieved, and return states, and take Apple Pay and Google Pay payments. Returns JSON over a REST API authenticated with an API key.
Use for: I want to list my marketplace orders, Get the detail of a specific order, Cancel an order by its id, Mark an order as in delivery
Not supported: Does not manage product catalogues, inventory, or shipping labels. Use for marketplace order lifecycle and Apple Pay and Google Pay payments only.
The Beebs Orders API manages marketplace orders and their payments. It lists a buyer's orders, reads a single order, and moves an order through its lifecycle with cancel, litigation cancel, additional depositing time, in-delivery, retrieved, and seller return-approval actions. Payment operations take Apple Pay and Google Pay, including an Apple Pay session setup.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orders 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%2Fbeebs.app%2Fbeebs" | shStep 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%2Fbeebs.app%2Fbeebs" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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.
What an agent can do with Orders API.
List a buyer's marketplace orders and read a single order's detail
Cancel an order or cancel a litigation on it
Advance an order through depositing, delivery, and retrieved states
Approve a buyer's return request as the seller
Take payments through Apple Pay and Google Pay
Patterns agents use Orders API for, with concrete tasks.
★ AI Agent Order Integration via Jentic
An agent that handles marketplace fulfilment can call the Beebs Orders API through Jentic without wiring the API key or shaping the payment payloads. The agent searches by intent, receives the operation schema, and lists orders or advances one through its lifecycle. This fits seller-side agents that track orders and confirm deliveries.
Search Jentic for 'list my orders', load the operation schema, and read back the buyer's orders
Order Lifecycle Management
Move an order from placement through delivery and completion. The Beebs Orders API lets an agent list orders, read one, grant additional depositing time, mark it in delivery, mark it retrieved, or cancel it, so a fulfilment workflow can advance each order to its next state.
Call GET /orders to list orders, then POST /orders/{id}/in-delivery to mark one in delivery
Seller Return Approval
Let a seller agent approve a buyer's return on a specific order. The Beebs Orders API exposes a seller return-approval action and a litigation-cancel action, so an agent can resolve returns and disputes directly against the order.
Call POST /orders/{id}/sellerApproveReturn to approve a buyer's return
Marketplace Payments
Take payment for an order through Apple Pay or Google Pay. The Beebs Orders API processes an Apple Pay or Google Pay payment and can open an Apple Pay session first, so a checkout agent can complete payment alongside the order it belongs to.
Call POST /payment/applepay to take an Apple Pay payment for an order
11 endpoints — the beebs orders api manages marketplace orders and their payments.
METHOD
PATH
DESCRIPTION
/orders
List the buyer's orders
/orders/{id}
Get one order
/orders/{id}/cancel
Cancel an order
/orders/{id}/in-delivery
Mark an order in delivery
/orders/{id}/retrieved
Mark an order retrieved
/orders/{id}/sellerApproveReturn
Approve a return as the seller
/payment/applepay
Make an Apple Pay payment
/payment/googlepay
Make a Google Pay payment
/orders
List the buyer's orders
/orders/{id}
Get one order
/orders/{id}/cancel
Cancel an order
/orders/{id}/in-delivery
Mark an order in delivery
/orders/{id}/retrieved
Mark an order retrieved
/orders/{id}/sellerApproveReturn
Approve a return as the seller
/payment/applepay
Make an Apple Pay payment
/payment/googlepay
Make a Google Pay payment
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Beebs Orders API by hand means managing its API key in the Authorization header, pointing calls at the right order id, and shaping the Apple Pay and Google Pay payment payloads yourself. Through Jentic you install once, import Beebs from the API Directory, store the key once, and your agent calls it.
Permission scoping
Beebs puts the order id in the URL path (/orders/{id}/...), so a rule can pin your agent to one order and the operations you pick. You choose the operations it may call, so state-changing ones like cancelling an order or approving a return are not included unless you add them.
Credential isolation
Your Beebs API key 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 'list my orders' or 'take an Apple Pay payment', and Jentic returns the matching Beebs operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Orders API through Jentic.
Is there a Beebs MCP server?
You don't need a separate MCP server to give your agent the Beebs Orders API. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls the order and payment operations it needs.
Can I limit what my agent is allowed to do with the Beebs Orders API?
Yes. The order id sits in the URL path, so you write a rule that allows reading orders and marking delivery for one order, and the agent can advance that order while cancelling it or approving returns stays out of reach. Every call is logged by your self-hosted instance.
What authentication does the Beebs Orders API use?
The Beebs Orders API authenticates with an API key sent in the Authorization header, per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never reaches the agent's context.
Can I take Apple Pay and Google Pay payments with the Beebs Orders API?
Yes. One operation processes an Apple Pay payment and another processes a Google Pay payment, with a separate call to open an Apple Pay session first. These sit alongside the order lifecycle operations.
What are the rate limits for the Beebs Orders API?
The OpenAPI spec does not specify rate limits. Check the vendor's documentation at https://beebs.app for current limits.
How do I list orders with the Beebs Orders API through Jentic?
Search Jentic for 'list my orders' and it returns the Beebs orders operation with its input schema; the agent reads back the buyer's orders as JSON. To run it on your own infrastructure, install Jentic One from its GitHub repo.
GET STARTED