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

# ShipMonk API

ShipMonk fulfillment API for managing orders, inventory, products, receivings, returns, and warehouses. The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create or update order, get order. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Create or Update Order
- Get Order
- Retrieve List of Orders
- Submit Order
- Complete Order (Sandbox)

## Use cases

### E-Commerce Operations

Use the ShipMonk API to perform e commerce operations programmatically. The API provides 19 endpoints covering core functionality including create or update order, get order, retrieve list of orders.

Example prompt: Call POST `/v1/integrations/order` to create or update order

### Automated Orders Management

Automate orders operations by combining multiple ShipMonk API endpoints. Agents can get order and then retrieve list of orders in a single workflow.

Example prompt: Call GET `/v1/integrations/orders` to get order, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ShipMonk 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 tokens manually.

Example prompt: Search Jentic for 'create or update order', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/integrations/order` | Create or Update Order |
| GET | `/v1/integrations/orders` | Get Order |
| GET | `/v1/integrations/orders-list` | Retrieve List of Orders |
| POST | `/v1/integrations/submit-order` | Submit Order |
| POST | `/v1/integrations/sandbox/complete-order` | Complete Order (Sandbox) |
| POST | `/v1/integrations/receiving` | Create or Update Receiving |
| GET | `/v1/integrations/receiving` | Get Receiving |
| GET | `/v1/integrations/receivings-list` | Retrieve List of Receivings |

## Key resources

- **Orders** — Operations related to Orders
- **Products** — Operations related to Products
- **Receivings** — Operations related to Receivings
- **Returns** — Operations related to Returns
- **Warehouses** — Operations related to Warehouses

## AI readiness

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.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/shipmonk.com/shipmonk/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the ShipMonk API by hand means placing your key in the X-API-Key header, pointing at the app.shipmonk.com host, and threading it through order and receiving calls yourself. Through Jentic you install once, import the ShipMonk API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** ShipMonk takes its order and receiving details in the request body rather than as path resources, so scope the agent to the operations it needs, such as creating an order or submitting a receiving, and leave out the ones it should not run.
- **Credential handling:** Your ShipMonk 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.
- **Discovery method:** Agents search Jentic by intent such as 'create or update an order' or 'submit an order', and Jentic returns the matching ShipMonk operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the ShipMonk API use?

The ShipMonk API uses an API key passed in the `X-API-Key` header. 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 create or update order with the ShipMonk API?

Yes. Use the POST `/v1/integrations/order` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ShipMonk 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 create or update order through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create or update order'. Jentic returns the matching ShipMonk API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ShipMonk API have?

The ShipMonk API exposes 19 endpoints covering orders, products, receivings operations.

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

Yes. Because you run Jentic One yourself, you decide which ShipMonk operations the agent may call and which stored API key it uses. ShipMonk passes order and receiving details in the request body rather than as path resources, so you scope the agent to just the operations it needs, such as creating an order or submitting a receiving, and leave out the ones it should not run.