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

# ShipStation API

ShipStation shipping and order management API. The API exposes 40 endpoints secured with basic authentication.

## For AI agents

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

## Scope

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

## Capabilities

- Create order
- List orders
- Get order
- Delete order
- Hold order until date
- Mark order as shipped

## Use cases

### E-Commerce Operations

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

Example prompt: Call POST /orders to create order

### Automated Account Management

Automate account operations by combining multiple ShipStation 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 ShipStation 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/{orderId} | Get order |
| DELETE | /orders/{orderId} | Delete order |
| POST | /orders/createorders | Create/update multiple orders |
| POST | /orders/holduntil | Hold order until date |
| POST | /orders/markasshipped | Mark order as shipped |
| POST | /orders/restorefromhold | Restore order from hold |

## Key resources

- **Account** — Operations related to Account
- **Carriers** — Operations related to Carriers
- **Customers** — Operations related to Customers
- **Fulfillments** — Operations related to Fulfillments
- **Orders** — Operations related to Orders

## Why Jentic

- **Setup:** Wiring the ShipStation API by hand means handling its basic auth, pointing at the ssapi.shipstation.com host, and threading credentials through order and fulfillment calls yourself. Through Jentic you install once, import the ShipStation API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** ShipStation puts the order id in the URL path (/orders/{orderId}), so a rule can pin your agent to one order. You choose the operations it may call, so a destructive one like deleting an order is not included unless you add it.
- **Credential handling:** Your ShipStation 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 'mark an order as shipped', and Jentic returns the matching ShipStation 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 ShipStation API use?

The ShipStation 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 ShipStation 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 ShipStation 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 ShipStation API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The ShipStation API exposes 40 endpoints covering account, carriers, customers operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which ShipStation operations and credentials your agent may use. You can allow only the calls you want, such as creating an order with POST /orders or listing orders with GET /orders, and leave a destructive operation like DELETE /orders/{orderId} out unless you explicitly add it. Since ShipStation carries the order id in the URL path (/orders/{orderId}), a rule can also pin your agent to a single order.