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

# Shiptheory API

Shiptheory provides a REST API that allows you to communicate directly with all supported carriers. This API covers creating and searching shipments, printing shipping labels and return labels, as well as returning lists of available delivery services and package sizes. The API exposes 23 endpoints secured with bearer authentication.

## For AI agents

Programmatically obtain authentication token, book a shipment. Covers 23 operations with bearer authentication.

## Scope

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

## Capabilities

- Obtain authentication token
- Book a shipment
- View shipment details
- List shipments
- Search shipments
- Download picking list PDF
- Create a return label

## Use cases

### CRM Operations

Use the Shiptheory API to perform crm operations programmatically. The API provides 23 endpoints covering core functionality including obtain authentication token, book a shipment, view shipment details.

Example prompt: Call POST /token to obtain authentication token

### Automated Packages Management

Automate packages operations by combining multiple Shiptheory API endpoints. Agents can book a shipment and then view shipment details in a single workflow.

Example prompt: Call POST /shipments to book a shipment, then verify the result

### AI Agent Integration via Jentic

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

Example prompt: Search Jentic for 'obtain authentication token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/token` | Obtain authentication token |
| POST | `/shipments` | Book a shipment |
| GET | `/shipments/{reference}` | View shipment details |
| GET | `/shipments/list` | List shipments |
| GET | `/shipments/search` | Search shipments |
| POST | `/picking_lists/download` | Download picking list PDF |
| POST | `/returns` | Create a return label |
| GET | `/returns` | List return shipments |

## Key resources

- **Packages** — Operations for packages
- **Picking_Lists** — Operations for picking_lists
- **Products** — Operations for products
- **Pudo** — Operations for pudo
- **Rating** — Operations for rating

## 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:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 71 / 100
- **View full report:** https://jentic.com/apis/shiptheory.com/shiptheory/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 Shiptheory API by hand means calling its token endpoint, setting the bearer token on the api.shiptheory.com host, and threading it through shipment and returns calls yourself. Through Jentic you install once, import the Shiptheory API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Shiptheory puts the shipment reference in the URL path (`/shipments/{reference}`), so a rule can pin your agent to one shipment reference. You choose the operations it may call, so writes it should not perform are left out unless you add them.
- **Credential handling:** Your Shiptheory 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 'create a shipment' or 'search shipments', and Jentic returns the matching Shiptheory 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 Shiptheory API use?

The Shiptheory API uses a Bearer token in the Authorization 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 obtain authentication token with the Shiptheory API?

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

### What are the rate limits for the Shiptheory 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 obtain authentication token through Jentic?

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

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

The Shiptheory API exposes 23 endpoints covering packages, picking_lists, products operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which Shiptheory operations and credentials the agent may use. Because Shiptheory puts the shipment reference in the URL path (`/shipments/{reference}`), a rule can pin the agent to a single shipment reference, and you choose which operations it can call, so write actions like POST /shipments or POST /returns stay out unless you add them. Read-only work such as GET `/shipments/list` or GET `/shipments/search` can be allowed on its own while booking and label creation remain blocked.