canonical: https://jentic.com/apis/swaggerhub.e2open/swaggerhub-e2open

# E2open Shipment Service API

Shipment Service API for Shipments, Legs, Loads, and Trade Data. The API exposes 14 endpoints.

## For AI agents

Programmatically save single tradedata object., finds and returns tradedata with given id.. Covers 14 operations.

## Scope

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

## Capabilities

- Save single TradeData object.
- Finds and returns Tradedata with given ID.
- Get and return all matching Customer Shipment Id + Tenant Id pairs.
- Updates existing shipment.
- Deletes Shipment with given ID.

## Use cases

### Developer Tools Operations

Use the Shipment Service API to perform developer tools operations programmatically. The API provides 14 endpoints covering core functionality including save single tradedata object., finds and returns tradedata with given id., save single shipment object..

Example prompt: Call POST /trade-data to save single tradedata object.

### Automated Shipment Management

Automate shipment operations by combining multiple Shipment Service API endpoints. Agents can finds and returns tradedata with given id. and then save single shipment object. in a single workflow.

Example prompt: Call GET `/trade-data/{id}` to finds and returns tradedata with given id., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Shipment Service 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 none tokens manually.

Example prompt: Search Jentic for 'save single tradedata object.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/trade-data` | Save single TradeData object. |
| GET | `/trade-data/{id}` | Finds and returns Tradedata with given ID. |
| POST | `/shipments` | Save single shipment object. |
| GET | `/shipments` | Get and return all matching Customer Shipment Id + Tenant Id pairs. |
| PUT | `/shipments` | Updates existing shipment. |
| GET | `/shipments/{id}` | Finds and returns shipment with given ID. |
| DELETE | `/shipments/{id}` | Deletes Shipment with given ID. |
| POST | `/leg` | Creates New Leg Entry in DB |

## Key resources

- **Shipment** — Calls related to Shipment Object
- **TradeData** — Calls related to TradeData Object
- **Leg** — Calls related to Legs

## Why Jentic

- **Setup:** Wiring the Shipment Service API by hand means reading its OpenAPI definition, targeting the right SwaggerHub server, and hand-coding each shipment, leg, and trade-data call with its retries yourself. Through Jentic you install once, import the Shipment Service API from the API Directory, store any credential it needs once, and your agent calls it.
- **Permission scoping:** The Shipment Service API puts the shipment id in the URL path (`/shipments/{id}`), so a rule can pin your agent to one shipment: it can read that shipment and nothing else. You choose the operations it may call, so destructive ones like deleting a shipment are not included unless you add them.
- **Credential handling:** Any credential this API requires 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 'create a shipment' or 'fetch trade data by id', and Jentic returns the matching Shipment Service API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Shipment Service API use?

The Shipment Service API uses no authentication. 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 save single tradedata object. with the Shipment Service API?

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

### What are the rate limits for the Shipment Service 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 save single tradedata object. through Jentic?

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

### How many endpoints does the Shipment Service API have?

The Shipment Service API exposes 14 endpoints covering shipment, tradedata, leg operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which of the Shipment Service API operations your agent may call and which credentials it may use. Since this API puts the shipment ID in the URL path (`/shipments/{id}`), you can pin the agent to reading a single shipment via GET `/shipments/{id}` and leave out everything else. Destructive operations such as DELETE `/shipments/{id}` or writes like POST /shipments and PUT /shipments are only available if you explicitly grant them.
