Webshipper API
56
AI ReadinessFoundational (C)56/100
Official vendor OpenAPI document · agent-readyE CommerceOrder Managementoauth210 EndpointsREST
For Agents
Programmatically obtain oauth2 access token, create order. Covers 10 operations with oauth2 authentication.
Use for: I need to obtain oauth2 access token, I want to order, Search for orders, Find all shipment
Not supported: Does not handle payments, communications, or crm - use for e-commerce only.
Webshipper API 2.0 - A RESTful JSON API following the JSON API standard for shipping and logistics management. Includes order management, shipment booking, carrier integration, rate quotes, and webhook support. The API exposes 10 endpoints secured with oauth2 authentication.
Install Jentic One Beta
Connect the Webshipper API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Webshipper 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%2Fwebshipper.io%2Fwebshipper" | 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%2Fwebshipper.io%2Fwebshipper" | 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 Webshipper API.
Obtain OAuth2 access token
Create order
List orders
Get rate quotes
Monitor Webshipper API operational status and events
Use Cases
Patterns agents use Webshipper API for, with concrete tasks.
★ E-Commerce Operations
Use the Webshipper API to perform e commerce operations programmatically. The API provides 10 endpoints covering core functionality including obtain oauth2 access token, create order, list orders.
Call POST /oauth/token to obtain oauth2 access token
Automated drop_point_locators Management
Automate drop_point_locators operations by combining multiple Webshipper API endpoints. Agents can create order and then list orders in a single workflow.
Call POST /orders to create order, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Webshipper 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 oauth2 tokens manually.
Search Jentic for 'obtain oauth2 access token', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
10 endpoints — webshipper api 2.
METHOD
PATH
DESCRIPTION
POST
/oauth/token
Obtain OAuth2 access token
POST
/orders
Create order
GET
/orders
List orders
POST
/shipments
Create shipment
GET
/shipments
List shipments
GET
/rate_quotes
Get rate quotes
GET
/service_quotes
Get service quotes
GET
/drop_point_locators
Find drop points
POST
/oauth/token
Obtain OAuth2 access token
POST
/orders
Create order
GET
/orders
List orders
POST
/shipments
Create shipment
GET
/shipments
List shipments
GET
/rate_quotes
Get rate quotes
GET
/service_quotes
Get service quotes
GET
/drop_point_locators
Find drop points
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.
W
Webshipper API
- Foundational (C)56/100
85
Foundational Compliance58
Developer Experience & Jentic Compatibility48
AI-Readiness & Agent Experience94
Agent Usability30
Security58
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
85
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
99%
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).
42%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
58
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C+Signals: 4
6%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
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.
48
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
32%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
59%
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.
30
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
30%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
58
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
57%
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 Webshipper by hand means running its OAuth2 token flow, resolving the per-account host in the {account_name}.api.webshipper.io base URL, and handling retries yourself. Through Jentic you install once, import Webshipper from the API Directory, store the OAuth2 credentials once, and your agent calls it.
Permission scoping
Webshipper takes order and shipment details in the request body rather than in the path, so limit the agent to the operations it needs, such as creating orders or requesting rate quotes. You choose the operations it may call, so shipment creation is not included unless you add it.
Credential isolation
Your Webshipper OAuth2 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 shipping order' or 'get a rate quote', and Jentic returns the matching Webshipper 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.
Alternative
Stripe
Alternative e commerce API
Choose Stripe when you need a different approach to e commerce operations
FAQs
Specific to using Webshipper API through Jentic.
What authentication does the Webshipper API use?
The Webshipper API uses OAuth 2.0 for authorization. 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 oauth2 access token with the Webshipper API?
Yes. Use the POST /oauth/token endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Webshipper 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 oauth2 access token through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'obtain oauth2 access token'. Jentic returns the matching Webshipper API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Webshipper API have?
The Webshipper API exposes 10 endpoints covering drop_point_locators, oauth, orders operations.
Can I limit what my agent is allowed to do with the Webshipper API?
Yes. Because Jentic One is self-hosted by you, your own rules decide which Webshipper operations and OAuth2 credentials the agent may use. Webshipper passes order and shipment details in the request body rather than the path, so you can grant only the operations the agent needs, such as creating orders or requesting rate quotes, and leave out shipment creation unless you add it. The agent can call nothing beyond the operations and credentials you have approved.
GET STARTED