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

# Shipday API

Shipday delivery management API for managing orders, drivers, carriers, and tracking. The API exposes 18 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get active orders, get order details. Covers 18 operations with apiKey authentication.

## Scope

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

## Capabilities

- Get active orders
- Edit order
- Delete order
- Create order
- Query orders
- Assign order to driver

## Use cases

### Analytics Operations

Use the Shipday API to perform analytics operations programmatically. The API provides 18 endpoints covering core functionality including get active orders, get order details, edit order.

Example prompt: Call GET /active-orders to get active orders

### Automated Carriers Management

Automate carriers operations by combining multiple Shipday API endpoints. Agents can get order details and then edit order in a single workflow.

Example prompt: Call GET `/orders/{id}` to get order details, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Shipday 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 'get active orders', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/active-orders` | Get active orders |
| GET | `/orders/{id}` | Get order details |
| PUT | `/orders/{id}` | Edit order |
| DELETE | `/orders/{id}` | Delete order |
| POST | `/orders` | Create order |
| POST | `/orders/query` | Query orders |
| PUT | `/orders/{id}/assign` | Assign order to driver |
| PUT | `/orders/{id}/unassign` | Unassign order |

## Key resources

- **Carriers** — Operations related to Carriers
- **Orders** — Operations related to Orders
- **Pickup Orders** — Operations related to Pickup Orders
- **Tracking** — Operations related to Tracking

## Why Jentic

- **Setup:** Wiring the Shipday API by hand means placing your key in the x-api-key header, pointing at the api.shipday.com host, and threading it through order creation and driver assignment calls yourself. Through Jentic you install once, import the Shipday API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Shipday puts the order id in the URL path (`/orders/{id}`), so a rule can pin your agent to one order for actions like assign and unassign. 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 Shipday 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 'get active orders' or 'assign a driver to an order', and Jentic returns the matching Shipday operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Shipday API use?

The Shipday API uses an API key passed in the `x-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 get active orders with the Shipday API?

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

### What are the rate limits for the Shipday 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 get active orders through Jentic?

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

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

The Shipday API exposes 18 endpoints covering carriers, orders, pickup orders operations.

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

Yes. Because Jentic One is self-hosted, you decide which Shipday operations your agent may call, so an operation like DELETE `/orders/{id}` stays off the list unless you add it. Since the order id sits in the URL path (`/orders/{id}`), your own rules can pin the agent to a single order for actions such as assign and unassign. The Shipday API key is held encrypted by your instance and injected only at execution, so the agent runs within the exact boundaries you set.