canonical: https://jentic.com/apis/swaggerhub.ferguson-api/api-shipping

# Ferguson Api API-Shipping

Ferguson's API Shipping Product for getting shipping rates. Returns an array of shipping rates based on destination city/state/postal code and list of products. Takes a JSON request payload that describes the Ferguson location id, destination address and products.   **_NOTE: basePath is actually /v1/shipping but is removed for readability._**. The API exposes 1 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically returns shipping options. Covers 1 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Returns shipping options
- Manage e commerce data programmatically
- Integrate API-Shipping into automated workflows
- Query and filter API-Shipping records by parameters
- Monitor API-Shipping operational status and events

## Use cases

### E-Commerce Operations

Use the API-Shipping to perform e commerce operations programmatically. The API provides 1 endpoints covering core functionality including returns shipping options.

Example prompt: Call POST /v1/shipping to returns shipping options

### Data Retrieval and Monitoring

Query API-Shipping resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary API-Shipping endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call API-Shipping 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 oauth2 tokens manually.

Example prompt: Search Jentic for 'returns shipping options', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/shipping | Returns shipping options |

## Key resources

- **Shipping** — Fetches shipping rates.

## Why Jentic

- **Setup:** Wiring the API-Shipping endpoint by hand means running Ferguson's OAuth 2.0 client credentials exchange against its token URL, refreshing the token before it expires, and attaching it to each request yourself. Through Jentic you install once, import API-Shipping from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** API-Shipping sends the shipping request in the body rather than a resource id in the path, so scope the agent to the operations it needs, in this case the single shipping call. You choose the operations it may call, so nothing beyond that is included unless you add it.
- **Credential handling:** Your Ferguson client 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 'get shipping options for an order', and Jentic returns the matching API-Shipping 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 API-Shipping use?

The API-Shipping uses OAuth 2.0 for authorization. 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 returns shipping options with the API-Shipping?

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

### What are the rate limits for the API-Shipping?

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 returns shipping options through Jentic?

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

### How many endpoints does the API-Shipping have?

The API-Shipping exposes 1 endpoints covering shipping operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, so you can scope it to just the single shipping call, POST /v1/shipping, which returns rates from a request body rather than acting on a resource id in the path. Nothing beyond the operations you grant is available to the agent, and your Ferguson OAuth 2.0 credentials stay stored and injected by your own instance rather than exposed in the agent context. If you never add write or account operations, the agent can only fetch shipping rates.