Official vendor OpenAPI document · agent-readyCRMContact ManagementapiKey, basic85 EndpointsREST
For Agents
Programmatically retrieve account infomation, retrieve balance. Covers 85 operations with apiKey, basic authentication.
Use for: I need to account infomation, I want to balance, Search for all payment requests, Find all all bookkeeping integrations
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
This is the official API for Shipmondo. The current version is v3. The Shipmondo API is documented using OpenAPI. You can find the OpenAPI spec here: https://app.shipmondo.com/api/public/v3/openapi.json We recommend that new implementations should be based on this version. We provide an official library for PHP, which you can find here: https://github.com/shipmondo/shipmondo_php_sdk If you need fu. The API exposes 85 endpoints secured with apiKey, basic authentication.
Install Jentic One Beta
Connect the Shipmondo API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Shipmondo 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.
1
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%2Fshipmondo.com%2Fshipmondo" | sh2
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%2Fshipmondo.com%2Fshipmondo" | 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.
Capabilities
What an agent can do with Shipmondo API.
Retrieve account infomation
List all payment requests
Create a bulk waybill
Query and filter Shipmondo API records by parameters
Monitor Shipmondo API operational status and events
Use Cases
Patterns agents use Shipmondo API for, with concrete tasks.
★ CRM Operations
Use the Shipmondo API to perform crm operations programmatically. The API provides 85 endpoints covering core functionality including retrieve account infomation, retrieve balance, list all payment requests.
Call GET /account/ to retrieve account infomation
Automated Account Management
Automate account operations by combining multiple Shipmondo API endpoints. Agents can retrieve balance and then list all payment requests in a single workflow.
Call GET /account/balance to retrieve balance, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Shipmondo API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, basic tokens manually.
Search Jentic for 'retrieve account infomation', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
85 endpoints — this is the official api for shipmondo.
METHOD
PATH
DESCRIPTION
GET
/account/
Retrieve account infomation
GET
/account/balance
Retrieve balance
GET
/account/payment_requests
List all payment requests
GET
/bookkeeping_integrations
List all bookkeeping integrations
GET
/bookkeeping_integrations/{id}
Retrieve a bookkeeping integration
POST
/waybills
Create a bulk waybill
GET
/waybills
List all bulk waybills
GET
/waybills/{id}
Retrieve a bulk waybill
GET
/account/
Retrieve account infomation
GET
/account/balance
Retrieve balance
GET
/account/payment_requests
List all payment requests
GET
/bookkeeping_integrations
List all bookkeeping integrations
GET
/bookkeeping_integrations/{id}
Retrieve a bookkeeping integration
POST
/waybills
Create a bulk waybill
GET
/waybills
List all bulk waybills
GET
/waybills/{id}
Retrieve a bulk waybill
Jentic AI Readiness Score
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.
S
Shipmondo API
- Foundational (D)44/100
58
Foundational Compliance74
Developer Experience & Jentic Compatibility54
AI-Readiness & Agent Experience88
Agent Usability13
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
58
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: C+Signals: 4
82%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
50%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
74
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
51%
Example Density
How richly the API is illustrated with examples.
93%
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.
54
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
66%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
96%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
55%
Summary Coverage
Coverage of summaries across operations/tags/info.
88
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: ASignals: 1
88%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
13
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
12%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
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>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Shipmondo API by hand means handling its basic auth, choosing between the sandbox and app hosts, and threading credentials through account and waybill calls yourself. Through Jentic you install once, import the Shipmondo API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Shipmondo puts the waybill id in the URL path (/waybills/{id}), so a rule can pin your agent to one waybill. You choose the operations it may call, so anything beyond reading and creating waybills is left out unless you add it.
Credential isolation
Your Shipmondo credentials 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.
Intent-based discovery
Agents search Jentic by intent such as 'retrieve account information' or 'create a waybill', and Jentic returns the matching Shipmondo operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Shipmondo API through Jentic.
What authentication does the Shipmondo API use?
The Shipmondo API uses apiKey, basic authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I retrieve account infomation with the Shipmondo API?
Yes. Use the GET /account/ endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Shipmondo API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I retrieve account infomation through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrieve account infomation'. Jentic returns the matching Shipmondo API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Shipmondo API have?
The Shipmondo API exposes 85 endpoints covering account, bookkeeping_integrations, carriers operations.
Can I limit what my agent is allowed to do with the Shipmondo API?
Yes. Because you run Jentic One yourself, your own rules decide which Shipmondo operations and credentials the agent can use, so you can allow just reading account details and creating waybills while leaving everything else out. Since Shipmondo puts the waybill id in the URL path (/waybills/{id}), a rule can pin the agent to a single waybill rather than the whole account. Any operation you do not explicitly grant stays unavailable to the agent.
GET STARTED