canonical: https://jentic.com/apis/webshipper.io/webshipper

# Webshipper API

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.

## For AI agents

Programmatically obtain oauth2 access token, create order. Covers 10 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Obtain OAuth2 access token
- Create order
- List orders
- Get rate quotes
- Monitor Webshipper API operational status and events

## Use cases

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

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

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

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

## Key endpoints

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

## Key resources

- **drop_point_locators** — Operations related to drop_point_locators
- **oauth** — Operations related to oauth
- **orders** — Operations related to orders
- **rate_quotes** — Operations related to rate_quotes
- **service_quotes** — Operations related to service_quotes

## 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:** 56 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 58 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 30 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/webshipper.io/webshipper/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 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 handling:** 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.
- **Discovery method:** 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

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

## FAQ

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