canonical: https://jentic.com/apis/shipmondo.com/shipmondo

# Shipmondo API

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.

## For AI agents

Programmatically retrieve account infomation, retrieve balance. Covers 85 operations with apiKey, basic authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- 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

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'retrieve account infomation', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| 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 |

## Key resources

- **Account** — Operations for account
- **Bookkeeping_Integrations** — Operations for bookkeeping_integrations
- **Carriers** — Operations for carriers
- **Documents** — Operations for documents
- **Fulfillments** — Operations for fulfillments

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### 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.