Shiptheory API
66
AI ReadinessAI-Aware (B)66/100
Official vendor OpenAPI document · agent-readyCRMCustomer Supportbearer23 EndpointsREST
For Agents
Programmatically obtain authentication token, book a shipment. Covers 23 operations with bearer authentication.
Use for: I need to obtain authentication token, I want to book a shipment, Search for view shipment details, Find all shipments
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
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.
Install Jentic One Beta
Connect the Shiptheory API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Shiptheory 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%2Fshiptheory.com%2Fshiptheory" | 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%2Fshiptheory.com%2Fshiptheory" | 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 Shiptheory API.
Obtain authentication token
Book a shipment
View shipment details
List shipments
Search shipments
Download picking list PDF
Create a return label
Use Cases
Patterns agents use Shiptheory API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'obtain authentication token', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
23 endpoints — shiptheory provides a rest api that allows you to communicate directly with all supported carriers.
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
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
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
Shiptheory API
- AI-Aware (B)66/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility46
AI-Readiness & Agent Experience94
Agent Usability60
Security71
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
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.
46
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
32%
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.
56%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
71
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
71%
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 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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Shiptheory API through Jentic.
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.
GET STARTED