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

# Ferguson Api API Order

Our Orders API allows you to place a purchase order for fulfillment. You can submit an order or fetch details on one single order. Submit an order(s): Fetches details for a specific order based on id: <b>API Product:</b> Order-Commerce(-UAT/-PROD) <br>. The API exposes 2 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically submit an order, returns a specific order. Covers 2 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Submit an order
- Returns a specific order
- Integrate API Order into automated workflows
- Query and filter API Order records by parameters
- Monitor API Order operational status and events

## Use cases

### E-Commerce Operations

Use the API Order to perform e commerce operations programmatically. The API provides 2 endpoints covering core functionality including submit an order, returns a specific order.

Example prompt: Call POST /v1/orders to submit an order

### Data Retrieval and Monitoring

Query API Order 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 Order endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call API Order 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 'submit an order', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/orders | Submit an order |
| GET | /v1/orders/{id} | Returns a specific order |

## Key resources

- **Order Operations** — Operations related to Order Operations

## Why Jentic

- **Setup:** Wiring the API Order endpoint by hand means running Ferguson's OAuth 2.0 client credentials exchange, choosing between the UAT and production hosts, and refreshing the token yourself. Through Jentic you install once, import API Order from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** API Order puts the order id in the URL path (/v1/orders/{id}), so a rule can pin your agent to reading a single order. You choose the operations it may call, so submitting a new order is not 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 'submit an order' or 'check the status of an order', and Jentic returns the matching API Order 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 Order use?

The API Order 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 submit an order with the API Order?

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

### What are the rate limits for the API Order?

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 submit an order through Jentic?

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

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

The API Order exposes 2 endpoints covering order operations operations.

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

Yes. Because you self-host Jentic One, your own rules decide which API Order operations and credentials the agent may use. Since the order id sits in the URL path at GET /v1/orders/{id}, you can pin the agent to reading a single order, and because you pick the allowed operations, submitting a new order via POST /v1/orders stays off limits unless you add it. Your Ferguson OAuth 2.0 client credentials are stored encrypted by your own instance and injected only for the calls you permit.