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

# ShipBob API Reference

ShipBob fulfillment API for managing orders, shipments, channels, and shipping methods. The API exposes 11 endpoints secured with bearer authentication.

## For AI agents

Programmatically get channels, create order. Covers 11 operations with bearer authentication.

## Scope

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

## Capabilities

- Get Channels
- Create Order
- Cancel Order
- Query and filter ShipBob API Reference records by parameters
- Monitor ShipBob API Reference operational status and events

## Use cases

### E-Commerce Operations

Use the ShipBob API Reference to perform e commerce operations programmatically. The API provides 11 endpoints covering core functionality including get channels, create order, get orders.

Example prompt: Call GET `/2026-01/channel` to get channels

### Automated Channels Management

Automate channels operations by combining multiple ShipBob API Reference endpoints. Agents can create order and then get orders in a single workflow.

Example prompt: Call POST `/2026-01/order` to create order, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ShipBob API Reference 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 'get channels', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/2026-01/channel` | Get Channels |
| POST | `/2026-01/order` | Create Order |
| GET | `/2026-01/order` | Get Orders |
| GET | `/2026-01/order/{orderId}` | Get Order |
| POST | `/2026-01/order/{orderId}:cancel` | Cancel Order |
| GET | `/2026-01/shipment/{shipmentId}` | Get Shipment |
| POST | `/2026-01/shipment/{shipmentId}:cancel` | Cancel Shipment |
| GET | `/2026-01/shipment/{shipmentId}/timeline` | Get Shipment Timeline |

## Key resources

- **Channels** — Operations related to Channels
- **Orders** — Operations related to Orders
- **Shipments** — Operations related to Shipments
- **Shipping** — Operations related to Shipping

## Why Jentic

- **Setup:** Wiring the ShipBob API by hand means setting its bearer token, pinning each call to the versioned path on the api.shipbob.com host, and managing order and shipment lifecycle calls yourself. Through Jentic you install once, import the ShipBob API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** ShipBob puts the order and shipment ids in the URL path (`/2026-01/order/{orderId}`, `/2026-01/shipment/{shipmentId}`), so a rule can pin your agent to one order or shipment. You choose the operations it may call, so a destructive one like canceling an order is not included unless you add it.
- **Credential handling:** Your ShipBob token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get channels' or 'get an order's shipment timeline', and Jentic returns the matching ShipBob 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 ShipBob API Reference use?

The ShipBob API Reference 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 get channels with the ShipBob API Reference?

Yes. Use the GET `/2026-01/channel` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ShipBob API Reference?

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 get channels through Jentic?

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

### How many endpoints does the ShipBob API Reference have?

The ShipBob API Reference exposes 11 endpoints covering channels, orders, shipments operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which ShipBob operations and credentials the agent may use. Because ShipBob carries the order and shipment ids in the URL path (`/2026-01/order/{orderId}`, `/2026-01/shipment/{shipmentId}`), a rule can pin the agent to a single order or shipment. You also choose the operations it may call, so a destructive one like canceling an order or shipment is excluded unless you explicitly add it.