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

# ShipEngine API

ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build pow. The API exposes 96 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list account settings, create an account image. Covers 96 operations with apiKey authentication.

## Scope

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

## Capabilities

- List Account Settings
- Create an Account Image
- Get Account Image By ID
- Update Account Image By ID
- Delete Account Image By Id
- Parse an address

## Use cases

### E-Commerce Operations

Use the ShipEngine API to perform e commerce operations programmatically. The API provides 96 endpoints covering core functionality including list account settings, create an account image, list account images.

Example prompt: Call GET /v1/account/settings to list account settings

### Automated account Management

Automate account operations by combining multiple ShipEngine API endpoints. Agents can create an account image and then list account images in a single workflow.

Example prompt: Call POST /v1/account/settings/images to create an account image, then verify the result

### AI Agent Integration via Jentic

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

Example prompt: Search Jentic for 'list account settings', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v1/account/settings | List Account Settings |
| POST | /v1/account/settings/images | Create an Account Image |
| GET | /v1/account/settings/images | List Account Images |
| GET | /v1/account/settings/images/{label_image_id} | Get Account Image By ID |
| PUT | /v1/account/settings/images/{label_image_id} | Update Account Image By ID |
| DELETE | /v1/account/settings/images/{label_image_id} | Delete Account Image By Id |
| PUT | /v1/addresses/recognize | Parse an address |
| POST | /v1/addresses/validate | Validate An Address |

## Key resources

- **account** — For additional information about the ShipEngine account.
- **addresses** — No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom
- **batches** — batches
- **carrier_accounts** — A carrier account is a connection to a shipping carrier that allows you to create labels, track pack
- **carriers** — carriers

## Why Jentic

- **Setup:** Wiring the ShipEngine API by hand means placing your key in the API-Key header, pointing at the api.shipengine.com host, and threading it through account, address, and label calls yourself. Through Jentic you install once, import the ShipEngine API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** ShipEngine puts the label image id in the URL path (/v1/account/settings/images/{label_image_id}), so a rule can pin your agent to one image resource. You choose the operations it may call, so a destructive one like deleting an image is not included unless you add it.
- **Credential handling:** Your ShipEngine API key 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 'validate an address' or 'list account settings', and Jentic returns the matching ShipEngine 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 ShipEngine API use?

The ShipEngine API uses an API key passed in the `API-Key` 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 list account settings with the ShipEngine API?

Yes. Use the GET /v1/account/settings endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ShipEngine 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 list account settings through Jentic?

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

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

The ShipEngine API exposes 96 endpoints covering account, addresses, batches operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which ShipEngine operations and credentials your agent can use. You pick the exact endpoints it may call, so a destructive action like DELETE /v1/account/settings/images/{label_image_id} stays out unless you explicitly add it. Because ShipEngine puts the label image id in the URL path, a rule can also pin the agent to a single image resource rather than every account image.