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

# Shipwire API

Shipwire provides fulfillment and warehouse management APIs for managing orders, inventory, shipments, returns, and warehouses. The API exposes 18 endpoints secured with basic authentication.

## For AI agents

Programmatically create order, list orders. Covers 18 operations with basic authentication.

## Scope

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

## Capabilities

- Create order
- List orders
- Get order
- Update order
- Cancel order

## Use cases

### E-Commerce Operations

Use the Shipwire API to perform e commerce operations programmatically. The API provides 18 endpoints covering core functionality including create order, list orders, get order.

Example prompt: Call POST /orders to create order

### Automated Inventory Management

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

Example prompt: Call GET /orders to list orders, then verify the result

### AI Agent Integration via Jentic

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

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/orders` | Create order |
| GET | `/orders` | List orders |
| GET | `/orders/{id}` | Get order |
| PUT | `/orders/{id}` | Update order |
| POST | `/orders/{id}/cancel` | Cancel order |
| GET | `/stock` | List stock |
| POST | `/products` | Create product |
| GET | `/products` | List products |

## Key resources

- **Inventory** — Operations related to Inventory
- **Orders** — Operations related to Orders
- **Products** — Operations related to Products
- **Rates** — Operations related to Rates
- **Receivings** — Operations related to Receivings

## 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:** 41 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 81 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/shipwire.com/shipwire/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 Shipwire API by hand means handling its basic auth, pointing at the api.shipwire.com host, and threading credentials through order, stock, and product calls yourself. Through Jentic you install once, import the Shipwire API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Shipwire puts the order id in the URL path (`/orders/{id}`), so a rule can pin your agent to one order for reads, updates, and cancel. You choose the operations it may call, so anything it should not touch is left out unless you add it.
- **Credential handling:** Your Shipwire 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 an order' or 'check stock levels', and Jentic returns the matching Shipwire 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 Shipwire API use?

The Shipwire API uses HTTP Basic authentication with username and password. 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 order with the Shipwire API?

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

### What are the rate limits for the Shipwire 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 order through Jentic?

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

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

The Shipwire API exposes 18 endpoints covering inventory, orders, products operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which Shipwire operations and credentials your agent may use. You can allow only the calls it needs, such as GET /orders and GET /stock for read-only checks while withholding POST /orders, PUT `/orders/{id}`, and POST `/orders/{id}/cancel.` Because Shipwire carries the order id in the URL path (`/orders/{id}`), a rule can pin the agent to a single order for reads, updates, and cancellations, and anything you do not grant stays out of reach.